wppaste
WordPress

wp_ajax_widgets_order()

Since
3.1.0
Source
wp-admin/includes/ajax-actions.php:2304
Handles saving the widgets order via AJAX.

Compatibility

WordPress
since 3.1.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_widgets_order() 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

Reads stored settings via update_option(), cached per request but not free on a cold cache.

Scaling
Scales with input

The body loops, so the work grows with how much data it finds.

Instructions
20–39

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

  • hookthird-party callbacksdo_action()one call below wp_ajax_widgets_order()
  • optionoption read or writeupdate_option()one call below wp_ajax_widgets_order()

Further down the call graph this can also reach serialize, cache, 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 · 4 distinct outcomes

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

WhenInstructionsCalls it makes
current_user_can()20check_ajax_referer(), current_user_can(), wp_die()
!current_user_can()23check_ajax_referer(), current_user_can(), wp_die(), wp_die()
current_user_can()35–36check_ajax_referer(), current_user_can(), wp_unslash(), wp_set_sidebars_widgets(), wp_die(), wp_die()
!current_user_can()38–39check_ajax_referer(), current_user_can(), wp_die(), wp_unslash(), wp_set_sidebars_widgets(), wp_die(), wp_die()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev6220–398
8.56220–398
8.46220–3989 fewer instructions than PHP 8.3
8.37120–398
8.27120–398
8.17120–3981 fewer instruction than PHP 7.4
7.47220–398

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 · 6

  • 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.
  • wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
  • str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
  • wp_set_sidebars_widgets()Set the sidebar widget option to update sidebars.

Source code

function wp_ajax_widgets_order() {	check_ajax_referer( 'save-sidebar-widgets', 'savewidgets' ); 	if ( ! current_user_can( 'edit_theme_options' ) ) {		wp_die( -1 );	} 	unset( $_POST['savewidgets'], $_POST['action'] ); 	// Save widgets order for all sidebars.	if ( is_array( $_POST['sidebars'] ) ) {		$sidebars = array(); 		foreach ( wp_unslash( $_POST['sidebars'] ) as $key => $val ) {			$sb = array(); 			if ( ! empty( $val ) ) {				$val = explode( ',', $val ); 				foreach ( $val as $k => $v ) {					if ( ! str_contains( $v, 'widget-' ) ) {						continue;					} 					$sb[ $k ] = substr( $v, strpos( $v, '_' ) + 1 );				}			}			$sidebars[ $key ] = $sb;		} 		wp_set_sidebars_widgets( $sidebars );		wp_die( 1 );	} 	wp_die( -1 );}

Changelog

Introduced in 3.1.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.7.7 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.