WP_REST_Menu_Items_Controller::prepare_item_for_database( WP_REST_Request $request ): object|WP_Error

Compatibility

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

Parameters

$requestWP_REST_Request

Request object.

Return value

object|WP_Error

Performance profile

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

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

44–137

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

Plugin surface

1 hook

Third-party callbacks on 'rest_pre_insert_nav_menu_item' run inside this call, and their cost is not bounded by anything here.

Called by

2

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

What it touches

• querycontent queryget_term()called directly
• hookthird-party callbacksapply_filters()called directly

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 · 84 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_item_for_database() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 1

One hook fires while WP_REST_Menu_Items_Controller::prepare_item_for_database() runs, in this order:

1. 1
   apply_filters( rest_pre_insert_nav_menu_item )filterline 496 (+153 into the body)

   Filters a menu item before it is inserted via the REST API.

Uses · 14

• is_wp_error()Checks whether the given variable is a WordPress Error.
• get_taxonomy()Retrieves the taxonomy object of $taxonomy.
• absint()Converts a value to non-negative integer.
• get_term()Gets all term data from database by term ID.
• __()Retrieves the translation of $text.
• get_term_field()Gets sanitized term field.
• get_post()Retrieves post data given a post ID or post object.
• get_post_type()Retrieves the post type of the current post or of a given post.
• get_post_type_object()Retrieves a post type object by name.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_REST_Menu_Items_Controller::get_nav_menu_item()Gets the nav menu item, if the ID is valid.
• WP_REST_Menu_Items_Controller::get_menu_id()Gets the id of the menu that the given menu item belongs to.

Used by · 2

• WP_REST_Menu_Items_Controller::create_item()Creates a single nav menu item.
• WP_REST_Menu_Items_Controller::update_item()Updates a single nav menu item.

Source code

View on Trac ↗View on GitHub ↗

343	protected function prepare_item_for_database( $request ) {344		$menu_item_db_id = $request['id'];345		$menu_item_obj   = $this->get_nav_menu_item( $menu_item_db_id );346		// Need to persist the menu item data. See https://core.trac.wordpress.org/ticket/28138347		if ( ! is_wp_error( $menu_item_obj ) ) {348			// Correct the menu position if this was the first item. See https://core.trac.wordpress.org/ticket/28140349			$position = ( 0 === $menu_item_obj->menu_order ) ? 1 : $menu_item_obj->menu_order;350 351			$prepared_nav_item = array(352				'menu-item-db-id'       => $menu_item_db_id,353				'menu-item-object-id'   => $menu_item_obj->object_id,354				'menu-item-object'      => $menu_item_obj->object,355				'menu-item-parent-id'   => $menu_item_obj->menu_item_parent,356				'menu-item-position'    => $position,357				'menu-item-type'        => $menu_item_obj->type,358				'menu-item-title'       => $menu_item_obj->title,359				'menu-item-url'         => $menu_item_obj->url,360				'menu-item-description' => $menu_item_obj->description,361				'menu-item-attr-title'  => $menu_item_obj->attr_title,362				'menu-item-target'      => $menu_item_obj->target,363				'menu-item-classes'     => $menu_item_obj->classes,364				// Stored in the database as a string.365				'menu-item-xfn'         => explode( ' ', $menu_item_obj->xfn ),366				'menu-item-status'      => $menu_item_obj->post_status,367				'menu-id'               => $this->get_menu_id( $menu_item_db_id ),368			);369		} else {370			$prepared_nav_item = array(371				'menu-id'               => 0,372				'menu-item-db-id'       => 0,373				'menu-item-object-id'   => 0,374				'menu-item-object'      => '',375				'menu-item-parent-id'   => 0,376				'menu-item-position'    => 1,377				'menu-item-type'        => 'custom',378				'menu-item-title'       => '',379				'menu-item-url'         => '',380				'menu-item-description' => '',381				'menu-item-attr-title'  => '',382				'menu-item-target'      => '',383				'menu-item-classes'     => array(),384				'menu-item-xfn'         => array(),385				'menu-item-status'      => 'publish',386			);387		}388 389		$mapping = array(390			'menu-item-db-id'       => 'id',391			'menu-item-object-id'   => 'object_id',392			'menu-item-object'      => 'object',393			'menu-item-parent-id'   => 'parent',394			'menu-item-position'    => 'menu_order',395			'menu-item-type'        => 'type',396			'menu-item-url'         => 'url',397			'menu-item-description' => 'description',398			'menu-item-attr-title'  => 'attr_title',399			'menu-item-target'      => 'target',400			'menu-item-classes'     => 'classes',401			'menu-item-xfn'         => 'xfn',402			'menu-item-status'      => 'status',403		);404 405		$schema = $this->get_item_schema();406 407		foreach ( $mapping as $original => $api_request ) {408			if ( isset( $request[ $api_request ] ) ) {409				$prepared_nav_item[ $original ] = $request[ $api_request ];410			}411		}412 413		$taxonomy = get_taxonomy( 'nav_menu' );414		$base     = ! empty( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name;415		// If menus submitted, cast to int.416		if ( ! empty( $request[ $base ] ) ) {417			$prepared_nav_item['menu-id'] = absint( $request[ $base ] );418		}419 420		// Nav menu title.421		if ( ! empty( $schema['properties']['title'] ) && isset( $request['title'] ) ) {422			if ( is_string( $request['title'] ) ) {

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.8.8 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.