WP_REST_Menu_Items_Controller::create_item( WP_REST_Request $request ): WP_REST_Response|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

Full details about the request.

Return value

WP_REST_Response|WP_Error

Response object on success, or WP_Error object on failure.

Performance profile

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

12–125

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

Plugin surface

2 hooks

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

Called by

0

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

What it touches

• hookthird-party callbacksdo_action()called directly
• querycontent queryget_post()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 · 9 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::create_item() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while WP_REST_Menu_Items_Controller::create_item() runs, in this order:

1. 1
   do_action( rest_insert_nav_menu_item )actionline 151 (+39 into the body)

   Fires after a single menu item is created or updated via the REST API.

2. 2
   do_action( rest_after_insert_nav_menu_item )actionline 181 (+69 into the body)

   Fires after a single menu item is completely created or updated via the REST API.

Uses · 15

• __()Retrieves the translation of $text.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_update_nav_menu_item()Saves the properties of a menu item or create a new one.
• wp_slash()Adds slashes to a string or recursively adds slashes to strings within an array.
• do_action()Calls the callback functions that have been added to an action hook.
• get_post()Retrieves post data given a post ID or post object.
• wp_after_insert_post()Fires actions after a post, its terms and meta data has been saved.
• rest_ensure_response()Ensures a REST response is a response object (for consistency).
• rest_url()Retrieves the URL to a REST endpoint.
• WP_Error::__construct()Initializes the error.
• WP_REST_Menu_Items_Controller::prepare_item_for_database()Prepares a single nav menu item for create or update.
• WP_REST_Menu_Items_Controller::get_nav_menu_item()Gets the nav menu item, if the ID is valid.

Source code

View on Trac ↗View on GitHub ↗

112	public function create_item( $request ) {113		if ( ! empty( $request['id'] ) ) {114			return new WP_Error( 'rest_post_exists', __( 'Cannot create existing post.' ), array( 'status' => 400 ) );115		}116 117		$prepared_nav_item = $this->prepare_item_for_database( $request );118 119		if ( is_wp_error( $prepared_nav_item ) ) {120			return $prepared_nav_item;121		}122		$prepared_nav_item = (array) $prepared_nav_item;123 124		$nav_menu_item_id = wp_update_nav_menu_item( $prepared_nav_item['menu-id'], $prepared_nav_item['menu-item-db-id'], wp_slash( $prepared_nav_item ), false );125		if ( is_wp_error( $nav_menu_item_id ) ) {126			if ( 'db_insert_error' === $nav_menu_item_id->get_error_code() ) {127				$nav_menu_item_id->add_data( array( 'status' => 500 ) );128			} else {129				$nav_menu_item_id->add_data( array( 'status' => 400 ) );130			}131 132			return $nav_menu_item_id;133		}134 135		$nav_menu_item = $this->get_nav_menu_item( $nav_menu_item_id );136		if ( is_wp_error( $nav_menu_item ) ) {137			$nav_menu_item->add_data( array( 'status' => 404 ) );138 139			return $nav_menu_item;140		}141 142		/**143		 * Fires after a single menu item is created or updated via the REST API.144		 *145		 * @since 5.9.0146		 *147		 * @param object          $nav_menu_item Inserted or updated menu item object.148		 * @param WP_REST_Request $request       Request object.149		 * @param bool            $creating      True when creating a menu item, false when updating.150		 */151		do_action( 'rest_insert_nav_menu_item', $nav_menu_item, $request, true );152 153		$schema = $this->get_item_schema();154 155		if ( ! empty( $schema['properties']['meta'] ) && isset( $request['meta'] ) ) {156			$meta_update = $this->meta->update_value( $request['meta'], $nav_menu_item_id );157 158			if ( is_wp_error( $meta_update ) ) {159				return $meta_update;160			}161		}162 163		$nav_menu_item = $this->get_nav_menu_item( $nav_menu_item_id );164		$fields_update = $this->update_additional_fields_for_object( $nav_menu_item, $request );165 166		if ( is_wp_error( $fields_update ) ) {167			return $fields_update;168		}169 170		$request->set_param( 'context', 'edit' );171 172		/**173		 * Fires after a single menu item is completely created or updated via the REST API.174		 *175		 * @since 5.9.0176		 *177		 * @param object          $nav_menu_item Inserted or updated menu item object.178		 * @param WP_REST_Request $request       Request object.179		 * @param bool            $creating      True when creating a menu item, false when updating.180		 */181		do_action( 'rest_after_insert_nav_menu_item', $nav_menu_item, $request, true );182 183		$post = get_post( $nav_menu_item_id );184		wp_after_insert_post( $post, false, null );185 186		$response = $this->prepare_item_for_response( $post, $request );187		$response = rest_ensure_response( $response );188 189		$response->set_status( 201 );190		$response->header( 'Location', rest_url( sprintf( '%s/%s/%d', $this->namespace, $this->rest_base, $nav_menu_item_id ) ) );191

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