WP_REST_Terms_Controller::update_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_Terms_Controller::update_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

12–122

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

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

• querycontent queryget_term()called directly
• hookthird-party callbacksdo_action()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 · 25 distinct outcomes

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

Hooks and filters fired · 2

2 hooks fire while WP_REST_Terms_Controller::update_item() runs, in this order:

1. 1
   do_action( rest_insert_{$this->taxonomy} )actionline 709 (+40 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 729 (+60 into the body)

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

Uses · 14

• is_wp_error()Checks whether the given variable is a WordPress Error.
• is_taxonomy_hierarchical()Determines whether the taxonomy object is hierarchical.
• __()Retrieves the translation of $text.
• get_term()Gets all term data from database by term ID.
• wp_update_term()Updates term based on arguments provided.
• 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.
• rest_ensure_response()Ensures a REST response is a response object (for consistency).
• WP_REST_Terms_Controller::get_term()Get the term, if the ID is valid.
• WP_Error::__construct()Initializes the error.
• WP_REST_Terms_Controller::prepare_item_for_database()Prepares a single term for create or update.
• WP_REST_Terms_Controller::get_item_schema()Retrieves the term's schema, conforming to JSON Schema.

Source code

View on Trac ↗View on GitHub ↗

669	public function update_item( $request ) {670		$term = $this->get_term( $request['id'] );671		if ( is_wp_error( $term ) ) {672			return $term;673		}674 675		if ( isset( $request['parent'] ) ) {676			if ( ! is_taxonomy_hierarchical( $this->taxonomy ) ) {677				return new WP_Error(678					'rest_taxonomy_not_hierarchical',679					__( 'Cannot set parent term, taxonomy is not hierarchical.' ),680					array( 'status' => 400 )681				);682			}683 684			$parent = get_term( (int) $request['parent'], $this->taxonomy );685 686			if ( ! $parent ) {687				return new WP_Error(688					'rest_term_invalid',689					__( 'Parent term does not exist.' ),690					array( 'status' => 400 )691				);692			}693		}694 695		$prepared_term = $this->prepare_item_for_database( $request );696 697		// Only update the term if we have something to update.698		if ( ! empty( $prepared_term ) ) {699			$update = wp_update_term( $term->term_id, $term->taxonomy, wp_slash( (array) $prepared_term ) );700 701			if ( is_wp_error( $update ) ) {702				return $update;703			}704		}705 706		$term = get_term( $term->term_id, $this->taxonomy );707 708		/** This action is documented in wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php */709		do_action( "rest_insert_{$this->taxonomy}", $term, $request, false );710 711		$schema = $this->get_item_schema();712		if ( ! empty( $schema['properties']['meta'] ) && isset( $request['meta'] ) ) {713			$meta_update = $this->meta->update_value( $request['meta'], $term->term_id );714 715			if ( is_wp_error( $meta_update ) ) {716				return $meta_update;717			}718		}719 720		$fields_update = $this->update_additional_fields_for_object( $term, $request );721 722		if ( is_wp_error( $fields_update ) ) {723			return $fields_update;724		}725 726		$request->set_param( 'context', 'edit' );727 728		/** This action is documented in wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php */729		do_action( "rest_after_insert_{$this->taxonomy}", $term, $request, false );730 731		$response = $this->prepare_item_for_response( $term, $request );732 733		return rest_ensure_response( $response );734	}

Changelog

Introduced in 4.7.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/rest-api/endpoints/class-wp-rest-terms-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.