wppaste
WordPress

WP_Navigation_Fallback::update_wp_navigation_post_schema( array $schema ): array

Since
6.4.0
Source
wp-includes/class-wp-navigation-fallback.php:35
Updates the wp_navigation custom post type schema, in order to expose additional fields in the embeddable links of WP_REST_Navigation_Fallback_Controller.

Description

The Navigation Fallback endpoint may embed the full Navigation Menu object into the 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.

Used with the rest_wp_navigation_item_schema hook.

Compatibility

WordPress
since 6.4.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$schemaarray
The schema for the wp_navigation post.

Return value

array
The modified schema.

Performance profile

How much work a call to WP_Navigation_Fallback::update_wp_navigation_post_schema() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
84

Executed per call on PHP 8.5. The body compiles to 84.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Navigation_Fallback::update_wp_navigation_post_schema() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always84array_merge(), array_merge(), array_merge(), array_merge(), array_merge(), array_merge()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 84 instructions, 84 executed per call, 0 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Source code

	public static function update_wp_navigation_post_schema( $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' ) ); 		/*		 * 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;	}

Changelog

Introduced in 6.4.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/class-wp-navigation-fallback.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.