wp_ajax_delete_inactive_widgets()
- Since
- 4.4.0
- Source
wp-admin/includes/ajax-actions.php:2467
Compatibility
- WordPress
- since 4.4.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.
Performance profile
How much work a call to wp_ajax_delete_inactive_widgets() 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
- 33–37
- Plugin surface
- 3 hooks
- 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 how much data it finds.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 63.
Third-party callbacks on 'load-widgets.php', 'widgets.php', 'sidebar_admin_setup' 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()called directly - cacheobject cache
wp_cache_get()one call below wp_ajax_delete_inactive_widgets() - serializeserialisation
maybe_unserialize()one call below wp_ajax_delete_inactive_widgets()
Further down the call graph this can also reach 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_ajax_delete_inactive_widgets() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
current_user_can() | 33–34 | check_ajax_referer(), current_user_can(), do_action(), do_action(), do_action(), wp_get_sidebars_widgets(), wp_set_sidebars_widgets(), wp_die() |
!current_user_can() | 36–37 | check_ajax_referer(), current_user_can(), wp_die(), do_action(), do_action(), do_action(), wp_get_sidebars_widgets(), wp_set_sidebars_widgets(), wp_die() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 63 | 33–37 | 3 | |
| 8.5 | 63 | 33–37 | 3 | |
| 8.4 | 63 | 33–37 | 3 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 66 | 33–37 | 3 | |
| 8.2 | 66 | 33–37 | 3 | |
| 8.1 | 66 | 33–37 | 3 | |
| 7.4 | 66 | 33–37 | 3 |
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 · 3
3 hooks fire while wp_ajax_delete_inactive_widgets() runs, in this order:
- do_action( load-widgets.php )actionline 2476 (+9 into the body)
Fires early when editing the widgets displayed in sidebars.
- do_action( widgets.php )actionline 2478 (+11 into the body)
Fires early when editing the widgets displayed in sidebars.
- do_action( sidebar_admin_setup )actionline 2480 (+13 into the body)
Fires early before the Widgets administration screen loads, after scripts are enqueued.
Uses · 8
- check_ajax_referer()Verifies the Ajax request to prevent processing requests external of the blog.
- current_user_can()Returns whether the current user has the specified capability.
- wp_die()Kills WordPress execution and displays HTML page with an error message.
- do_action()Calls the callback functions that have been added to an action hook.
- wp_get_sidebars_widgets()Retrieves the full list of sidebars and their widget instance IDs.
- get_option()Retrieves an option value based on an option name.
- update_option()Updates the value of an option that was already added.
- wp_set_sidebars_widgets()Sets the sidebar widget option to update sidebars.
Source code
function wp_ajax_delete_inactive_widgets() { check_ajax_referer( 'remove-inactive-widgets', 'removeinactivewidgets' ); if ( ! current_user_can( 'edit_theme_options' ) ) { wp_die( -1 ); } unset( $_POST['removeinactivewidgets'], $_POST['action'] ); /** This action is documented in wp-admin/includes/ajax-actions.php */ do_action( 'load-widgets.php' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores /** This action is documented in wp-admin/includes/ajax-actions.php */ do_action( 'widgets.php' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores /** This action is documented in wp-admin/widgets.php */ do_action( 'sidebar_admin_setup' ); $sidebars_widgets = wp_get_sidebars_widgets(); foreach ( $sidebars_widgets['wp_inactive_widgets'] as $key => $widget_id ) { $pieces = explode( '-', $widget_id ); $multi_number = array_pop( $pieces ); $id_base = implode( '-', $pieces ); $widget = get_option( 'widget_' . $id_base ); unset( $widget[ $multi_number ] ); update_option( 'widget_' . $id_base, $widget ); unset( $sidebars_widgets['wp_inactive_widgets'][ $key ] ); } wp_set_sidebars_widgets( $sidebars_widgets ); wp_die();}Changelog
Introduced in 4.4.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.8.8 tag, from
src/wp-admin/includes/ajax-actions.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.