WP_REST_Sidebars_Controller::update_item( WP_REST_Request $request ): WP_REST_Response
- Since
- 5.8.0
- Source
wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php:216
Compatibility
- WordPress
- since 5.8.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
$requestWP_REST_Request- Full details about the request.
Return value
WP_REST_Response- Response object on success, or WP_Error object on failure.
Performance profile
How much work a call to WP_REST_Sidebars_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
- Scaling
- Scales with input
- Instructions
- 21–34
- Plugin surface
- 1 hook
- Called by
- 0
Reads stored settings via get_option(), cached per request but not free on a cold cache.
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 60.
Third-party callbacks on 'rest_save_sidebar' run inside this call, and their cost is not bounded by anything here.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
do_action()called directly - optionoption read or write
get_option()one call below WP_REST_Sidebars_Controller::update_item()
Further down the call graph this can also reach cache, serialize, query 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_Sidebars_Controller::update_item() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!isset($request) | 21 | ->get_sidebar(), do_action(), ->prepare_item_for_response() |
isset($request) | 33–34 | wp_get_sidebars_widgets(), wp_set_sidebars_widgets(), ->get_sidebar(), do_action(), ->prepare_item_for_response() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 60 | 21–34 | 9 | |
| 8.5 | 60 | 21–34 | 9 | |
| 8.4 | 60 | 21–34 | 9 | 6 fewer instructions than PHP 8.3 |
| 8.3 | 66 | 21–34 | 9 | |
| 8.2 | 66 | 21–34 | 9 | |
| 8.1 | 66 | 21–34 | 9 | |
| 7.4 | 66 | 21–34 | 9 |
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.
Hooks and filters fired · 1
One hook fires while WP_REST_Sidebars_Controller::update_item() runs, in this order:
- do_action( rest_save_sidebar )actionline 251 (+35 into the body)
Fires after a sidebar is updated via the REST API.
Uses · 5
- wp_get_sidebars_widgets()Retrieve full list of sidebars and their widget instance IDs.
- wp_set_sidebars_widgets()Set the sidebar widget option to update sidebars.
- do_action()Calls the callback functions that have been added to an action hook.
- WP_REST_Sidebars_Controller::get_sidebar()Retrieves the registered sidebar with the given id.
- WP_REST_Sidebars_Controller::prepare_item_for_response()Prepares a single sidebar output for response.
Source code
public function update_item( $request ) { if ( isset( $request['widgets'] ) ) { $sidebars = wp_get_sidebars_widgets(); foreach ( $sidebars as $sidebar_id => $widgets ) { foreach ( $widgets as $i => $widget_id ) { // This automatically removes the passed widget IDs from any other sidebars in use. if ( $sidebar_id !== $request['id'] && in_array( $widget_id, $request['widgets'], true ) ) { unset( $sidebars[ $sidebar_id ][ $i ] ); } // This automatically removes omitted widget IDs to the inactive sidebar. if ( $sidebar_id === $request['id'] && ! in_array( $widget_id, $request['widgets'], true ) ) { $sidebars['wp_inactive_widgets'][] = $widget_id; } } } $sidebars[ $request['id'] ] = $request['widgets']; wp_set_sidebars_widgets( $sidebars ); } $request['context'] = 'edit'; $sidebar = $this->get_sidebar( $request['id'] ); /** * Fires after a sidebar is updated via the REST API. * * @since 5.8.0 * * @param array $sidebar The updated sidebar. * @param WP_REST_Request $request Request object. */ do_action( 'rest_save_sidebar', $sidebar, $request ); return $this->prepare_item_for_response( $sidebar, $request ); }Changelog
Introduced in 5.8.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 6.7.7 tag, from
src/wp-includes/rest-api/endpoints/class-wp-rest-sidebars-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.