WP_REST_Posts_Controller::handle_terms( int $post_id, WP_REST_Request $request ): null|WP_Error
- Since
- 4.7.0
- Source
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php:1702
Compatibility
- WordPress
- since 4.7.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$post_idint- The post ID to update the terms form.
$requestWP_REST_Request- The request object with post and terms data.
Return value
null|WP_Error- WP_Error on an error assigning any of the terms, otherwise null.
Performance profile
How much work a call to WP_REST_Posts_Controller::handle_terms() 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
- Scaling
- Scales with input
- Instructions
- 16–38
- Plugin surface
- None
- Called by
- 2
Reaches the database via wp_get_object_terms().
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 41.
Nothing here hands control to plugin code.
2 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- querycontent query
wp_get_object_terms()one call below WP_REST_Posts_Controller::handle_terms() - hookthird-party callbacks
do_action()one call below WP_REST_Posts_Controller::handle_terms() - cacheobject cache
wp_cache_delete()one call below WP_REST_Posts_Controller::handle_terms()
Further down the call graph this can also reach option, 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 · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Posts_Controller::handle_terms() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 16–17 | get_object_taxonomies(), wp_list_filter() |
!$taxonomies && isset($request[$base]) && is_wp_error() | 37–38 | get_object_taxonomies(), wp_list_filter(), wp_set_object_terms(), is_wp_error() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 41 | 16–38 | 5 | |
| 8.5 | 41 | 16–38 | 5 | |
| 8.4 | 41 | 16–38 | 5 | |
| 8.3 | 41 | 16–38 | 5 | |
| 8.2 | 41 | 16–38 | 5 | |
| 8.1 | 41 | 16–38 | 5 | 2 fewer instructions than PHP 7.4 |
| 7.4 | 43 | 16–39 | 5 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 4
- wp_list_filter()Filters a list of objects, based on a set of key => value arguments.
- get_object_taxonomies()Returns the names or objects of the taxonomies which are registered for the requested object or object type, such as a post object or post type name.
- wp_set_object_terms()Creates term and taxonomy relationships.
- is_wp_error()Checks whether the given variable is a WordPress Error.
Used by · 2
- WP_REST_Posts_Controller::create_item()Creates a single post.
- WP_REST_Posts_Controller::update_item()Updates a single post.
Source code
protected function handle_terms( $post_id, $request ) { $taxonomies = wp_list_filter( get_object_taxonomies( $this->post_type, 'objects' ), array( 'show_in_rest' => true ) ); foreach ( $taxonomies as $taxonomy ) { $base = ! empty( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name; if ( ! isset( $request[ $base ] ) ) { continue; } $result = wp_set_object_terms( $post_id, $request[ $base ], $taxonomy->name ); if ( is_wp_error( $result ) ) { return $result; } } return null; }Changelog
Introduced in 4.7.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 tag, from
src/wp-includes/rest-api/endpoints/class-wp-rest-posts-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.