Changeset 58286 for trunk/src/wp-includes/rest-api.php

Timestamp:

06/02/2024 10:00:26 PM (11 months ago)

Author:

audrasjb

Message:

Embeds: Add titles to alternate resource links for oEmbed and REST API.

This changeset makes the following changes:

• Adds the title attribute to <link rel="alternate"> tags for oEmbed and REST API endpoints
• Updates the oEmbed phpunit tests to reflect the above change
• Adds the title link-param to REST API Link: headers (verified as supported in RFC 8288 here: ​https://httpwg.org/specs/rfc8288.html#serialisation-defined-attributes)

Props edent, kadamwhite, TimothyBlynJacobs, joedolson, swissspidy, sabernhardt.
Fixes #59006.

File:

• trunk/src/wp-includes/rest-api.php (modified) (2 diffs)

trunk/src/wp-includes/rest-api.php

@@ -1008 +1008 @@
 
     if ( $resource ) {
-        printf( '<link rel="alternate" type="application/json" href="%s" />', esc_url( rest_url( $resource ) ) );
+        printf(
+            '<link rel="alternate" title="%1$s" type="application/json" href="%2$s" />',
+            _x( 'JSON', 'REST API resource link name' ),
+            esc_url( rest_url( $resource ) )
+        );
     }
 }
@@ -1033 +1037 @@
 
     if ( $resource ) {
-        header( sprintf( 'Link: <%s>; rel="alternate"; type="application/json"', sanitize_url( rest_url( $resource ) ) ), false );
+        header(
+            sprintf(
+                'Link: <%1$s>; rel="alternate"; title="%2$s"; type="application/json"',
+                sanitize_url( rest_url( $resource ) ),
+                _x( 'JSON', 'REST API resource link name' )
+            ),
+            false
+        );
     }
 }