Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backport to 6.3 - Navigation: Load the raw property on the navigation fallback #4891

Closed
wants to merge 7 commits into from
Closed

Backport to 6.3 - Navigation: Load the raw property on the navigation fallback #4891

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
dbe113a
Backport https://github.com/WordPress/gutenberg/pull/52758/
ramonjd Jul 24, 2023
7d789ee
Updated typo in wp_add_fields_to_navigation_fallback_embeded_links
ramonjd Jul 24, 2023
a9e6760
This file wasn't imported :)
ramonjd Jul 24, 2023
dd278f7
Update annotations
ramonjd Jul 24, 2023
cc2b207
Update copy
ramonjd Jul 24, 2023
79ca1df
regenerate WP_Test_REST_Schema_Initialization
ramonjd Jul 24, 2023
8b03cfa
regenerate WP_Test_REST_Schema_Initialization
ramonjd Jul 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 21 additions & 6 deletions src/wp-includes/navigation-fallback.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,29 +13,44 @@
* Navigation Fallback REST endpoint.
*
* The endpoint may embed the full Navigation Menu object into the
* response as the `self` link. By default the Posts Controller
* will only exposes a limited subset of fields but the editor requires
* additional fields to be available in order to utilise the menu.
* response as the `self` link. By default, the Posts Controller
* will only expose a limited subset of fields but the editor requires
* additional fields to be available in order to utilize the menu.
*
* @since 6.3.0
*
* @param array $schema the schema for the `wp_navigation` post.
* @return array the modified schema.
*/
function wp_add_fields_to_navigation_fallback_embeded_links( $schema ) {
function wp_add_fields_to_navigation_fallback_embedded_links( $schema ) {
// Expose top level fields.
$schema['properties']['status']['context'] = array_merge( $schema['properties']['status']['context'], array( 'embed' ) );
$schema['properties']['content']['context'] = array_merge( $schema['properties']['content']['context'], array( 'embed' ) );

// Expose sub properties of content field.
/*
* Exposes sub properties of content field.
* These sub properties aren't exposed by the posts controller by default,
* for requests where context is `embed`.
*
* @see WP_REST_Posts_Controller::get_item_schema()
*/
$schema['properties']['content']['properties']['raw']['context'] = array_merge( $schema['properties']['content']['properties']['raw']['context'], array( 'embed' ) );
$schema['properties']['content']['properties']['rendered']['context'] = array_merge( $schema['properties']['content']['properties']['rendered']['context'], array( 'embed' ) );
$schema['properties']['content']['properties']['block_version']['context'] = array_merge( $schema['properties']['content']['properties']['block_version']['context'], array( 'embed' ) );

/*
* Exposes sub properties of title field.
* These sub properties aren't exposed by the posts controller by default,
* for requests where context is `embed`.
*
* @see WP_REST_Posts_Controller::get_item_schema()
*/
$schema['properties']['title']['properties']['raw']['context'] = array_merge( $schema['properties']['title']['properties']['raw']['context'], array( 'embed' ) );

return $schema;
}

add_filter(
'rest_wp_navigation_item_schema',
'wp_add_fields_to_navigation_fallback_embeded_links'
'wp_add_fields_to_navigation_fallback_embedded_links'
);
1 change: 1 addition & 0 deletions src/wp-settings.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,7 @@
require ABSPATH . WPINC . '/block-supports/spacing.php';
require ABSPATH . WPINC . '/block-supports/typography.php';
require ABSPATH . WPINC . '/block-supports/settings.php';
require ABSPATH . WPINC . '/navigation-fallback.php';
ramonjd marked this conversation as resolved.
Show resolved Hide resolved
require ABSPATH . WPINC . '/style-engine.php';
require ABSPATH . WPINC . '/style-engine/class-wp-style-engine.php';
require ABSPATH . WPINC . '/style-engine/class-wp-style-engine-css-declarations.php';
Expand Down
44 changes: 44 additions & 0 deletions tests/phpunit/tests/rest-api/rest-navigation-fallback-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,50 @@ public function test_adds_links() {
$this->assertTrue( $links['self'][0]['attributes']['embeddable'], 'Self link should be embeddable.' );
}

/**
* Tests that the correct filters are applied to the context parameter.
*
* By default, the REST response for the Posts Controller will not return all fields
* when the context is set to 'embed'. Assert that correct additional fields are added
* to the embedded Navigation Post, when the navigation fallback endpoint
* is called with the `_embed` param.
*
* @ticket 58557
*
* @covers wp_add_fields_to_navigation_fallback_embedded_links
*
* @since 6.3.0 Added Navigation Fallbacks endpoint.
*/
public function test_embedded_navigation_post_contains_required_fields() {
// First we'll use the navigation fallback to get a link to the navigation endpoint.
$request = new WP_REST_Request( 'GET', '/wp-block-editor/v1/navigation-fallback' );
$response = rest_get_server()->dispatch( $request );
$links = $response->get_links();

// Extract the navigation endpoint URL from the response.
$embedded_navigation_href = $links['self'][0]['href'];
preg_match( '/\?rest_route=(.*)/', $embedded_navigation_href, $matches );
$navigation_endpoint = $matches[1];

// Fetch the "linked" navigation post from the endpoint, with the context parameter set to 'embed' to simulate fetching embedded links.
$request = new WP_REST_Request( 'GET', $navigation_endpoint );
$request->set_param( 'context', 'embed' );
ramonjd marked this conversation as resolved.
Show resolved Hide resolved
$response = rest_get_server()->dispatch( $request );
$data = $response->get_data();

// Verify that the additional status field is present.
$this->assertArrayHasKey( 'status', $data, 'Response title should contain a "status" field.' );

// Verify that the additional content fields are present.
$this->assertArrayHasKey( 'content', $data, 'Response should contain a "content" field.' );
$this->assertArrayHasKey( 'raw', $data['content'], 'Response content should contain a "raw" field.' );
$this->assertArrayHasKey( 'rendered', $data['content'], 'Response content should contain a "rendered" field.' );
$this->assertArrayHasKey( 'block_version', $data['content'], 'Response should contain a "block_version" field.' );

// Verify that the additional title.raw field is present.
$this->assertArrayHasKey( 'raw', $data['title'], 'Response title should contain a "raw" key.' );
}

private function get_navigations_in_database() {
$navs_in_db = new WP_Query(
array(
Expand Down
36 changes: 24 additions & 12 deletions tests/qunit/fixtures/wp-api-generated.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6682,7 +6682,8 @@ mockedApiResponse.Schema = {
"description": "Title for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
"edit",
"embed"
]
},
"rendered": {
Expand All @@ -6706,23 +6707,26 @@ mockedApiResponse.Schema = {
"description": "Content for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
"edit",
"embed"
]
},
"rendered": {
"description": "HTML content for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit"
"edit",
"embed"
],
"readonly": true
},
"block_version": {
"description": "Version of the content block format used by the post.",
"type": "integer",
"context": [
"edit"
"edit",
"embed"
],
"readonly": true
},
Expand Down Expand Up @@ -6859,7 +6863,8 @@ mockedApiResponse.Schema = {
"description": "Title for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
"edit",
"embed"
]
},
"rendered": {
Expand All @@ -6883,23 +6888,26 @@ mockedApiResponse.Schema = {
"description": "Content for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
"edit",
"embed"
]
},
"rendered": {
"description": "HTML content for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit"
"edit",
"embed"
],
"readonly": true
},
"block_version": {
"description": "Version of the content block format used by the post.",
"type": "integer",
"context": [
"edit"
"edit",
"embed"
],
"readonly": true
},
Expand Down Expand Up @@ -7192,7 +7200,8 @@ mockedApiResponse.Schema = {
"description": "Title for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
"edit",
"embed"
]
},
"rendered": {
Expand All @@ -7216,23 +7225,26 @@ mockedApiResponse.Schema = {
"description": "Content for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
"edit",
"embed"
]
},
"rendered": {
"description": "HTML content for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit"
"edit",
"embed"
],
"readonly": true
},
"block_version": {
"description": "Version of the content block format used by the post.",
"type": "integer",
"context": [
"edit"
"edit",
"embed"
],
"readonly": true
},
Expand Down