WP_REST_Menus_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_Menus_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_term().

Scaling

Constant

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

Instructions

18–132

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

Plugin surface

2 hooks

Third-party callbacks on 'rest_insert_{$this->taxonomy}', 'rest_after_insert_{$this->taxonomy}' 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_term()one call below WP_REST_Menus_Controller::create_item()

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 · 20 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Menus_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_Menus_Controller::create_item() runs, in this order:

1. 1
   do_action( rest_insert_{$this->taxonomy} )actionline 246 (+42 into the body)

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

2. 2
   do_action( rest_after_insert_{$this->taxonomy} )actionline 274 (+70 into the body)

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

Uses · 18

• is_taxonomy_hierarchical()Determines whether the taxonomy object is hierarchical.
• __()Retrieves the translation of $text.
• wp_get_nav_menu_object()Returns a navigation menu object.
• wp_update_nav_menu_object()Saves the properties of a menu or create a new menu with those properties.
• wp_slash()Adds slashes to a string or recursively adds slashes to strings within an array.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• get_term_by()Gets all term data from database by term field and data.
• do_action()Calls the callback functions that have been added to an action hook.
• 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_Menus_Controller::prepare_item_for_database()Prepares a single term for create or update.

Source code

View on Trac ↗View on GitHub ↗

204	public function create_item( $request ) {205		if ( isset( $request['parent'] ) ) {206			if ( ! is_taxonomy_hierarchical( $this->taxonomy ) ) {207				return new WP_Error( 'rest_taxonomy_not_hierarchical', __( 'Cannot set parent term, taxonomy is not hierarchical.' ), array( 'status' => 400 ) );208			}209 210			$parent = wp_get_nav_menu_object( (int) $request['parent'] );211 212			if ( ! $parent ) {213				return new WP_Error( 'rest_term_invalid', __( 'Parent term does not exist.' ), array( 'status' => 400 ) );214			}215		}216 217		$prepared_term = $this->prepare_item_for_database( $request );218 219		$term = wp_update_nav_menu_object( 0, wp_slash( (array) $prepared_term ) );220 221		if ( is_wp_error( $term ) ) {222			/*223			 * If we're going to inform the client that the term already exists,224			 * give them the identifier for future use.225			 */226 227			if ( in_array( 'menu_exists', $term->get_error_codes(), true ) ) {228				$existing_term = get_term_by( 'name', $prepared_term->{'menu-name'}, $this->taxonomy );229				$term->add_data( $existing_term->term_id, 'menu_exists' );230				$term->add_data(231					array(232						'status'  => 400,233						'term_id' => $existing_term->term_id,234					)235				);236			} else {237				$term->add_data( array( 'status' => 400 ) );238			}239 240			return $term;241		}242 243		$term = $this->get_term( $term );244 245		/** This action is documented in wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php */246		do_action( "rest_insert_{$this->taxonomy}", $term, $request, true );247 248		$schema = $this->get_item_schema();249		if ( ! empty( $schema['properties']['meta'] ) && isset( $request['meta'] ) ) {250			$meta_update = $this->meta->update_value( $request['meta'], $term->term_id );251 252			if ( is_wp_error( $meta_update ) ) {253				return $meta_update;254			}255		}256 257		$locations_update = $this->handle_locations( $term->term_id, $request );258 259		if ( is_wp_error( $locations_update ) ) {260			return $locations_update;261		}262 263		$this->handle_auto_add( $term->term_id, $request );264 265		$fields_update = $this->update_additional_fields_for_object( $term, $request );266 267		if ( is_wp_error( $fields_update ) ) {268			return $fields_update;269		}270 271		$request->set_param( 'context', 'view' );272 273		/** This action is documented in wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php */274		do_action( "rest_after_insert_{$this->taxonomy}", $term, $request, true );275 276		$response = $this->prepare_item_for_response( $term, $request );277		$response = rest_ensure_response( $response );278 279		$response->set_status( 201 );280		$response->header( 'Location', rest_url( $this->namespace . '/' . $this->rest_base . '/' . $term->term_id ) );281 282		return $response;283	}

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