WP_REST_Menu_Items_Controller::prepare_links( WP_Post $post ): array

Compatibility

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

Parameters

$postWP_Post

Post object.

Return value

array

Links for the given post.

Performance profile

How much work a call to WP_REST_Menu_Items_Controller::prepare_links() 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

Heavy

Reaches the database via get_post().

Scaling

Constant

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

Instructions

14–47

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 61.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• querycontent queryget_post()one call below WP_REST_Menu_Items_Controller::prepare_links()
• hookthird-party callbacksapply_filters()one call below WP_REST_Menu_Items_Controller::prepare_links()

Further down the call graph this can also reach option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 6 distinct outcomes

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

Uses · 7

• rest_get_route_for_post()Gets the REST API route for a post.
• get_post_type()Retrieves the post type of the current post or of a given post.
• rest_get_route_for_term()Gets the REST API route for a term.
• get_term_field()Gets sanitized term field.
• rest_url()Retrieves the URL to a REST endpoint.
• WP_REST_Posts_Controller::prepare_links()Prepares links for the request.
• WP_REST_Menu_Items_Controller::get_nav_menu_item()Gets the nav menu item, if the ID is valid.

Used by · 1

• WP_REST_Menu_Items_Controller::prepare_item_for_response()Prepares a single nav menu item output for response.

Source code

View on Trac ↗View on GitHub ↗

665	protected function prepare_links( $post ) {666		$links     = parent::prepare_links( $post );667		$menu_item = $this->get_nav_menu_item( $post->ID );668 669		if ( empty( $menu_item->object_id ) ) {670			return $links;671		}672 673		$path = '';674		$type = '';675		$key  = $menu_item->type;676		if ( 'post_type' === $menu_item->type ) {677			$path = rest_get_route_for_post( $menu_item->object_id );678			$type = get_post_type( $menu_item->object_id );679		} elseif ( 'taxonomy' === $menu_item->type ) {680			$path = rest_get_route_for_term( $menu_item->object_id );681			$type = get_term_field( 'taxonomy', $menu_item->object_id );682		}683 684		if ( $path && $type ) {685			$links['https://api.w.org/menu-item-object'][] = array(686				'href'       => rest_url( $path ),687				$key         => $type,688				'embeddable' => true,689			);690		}691 692		return $links;693	}

Changelog

Introduced in 5.9.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 6.9.7 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-menu-items-controller.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.