wp_ajax_save_widget()

Compatibility

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_save_widget() 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 get_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

87–164

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

Plugin surface

4 hooks

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.

Called by

0

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

What it touches

• hookthird-party callbacksdo_action()called directly
• optionoption read or writeget_option()one call below wp_ajax_save_widget()

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 · 96 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 4

4 hooks fire while wp_ajax_save_widget() runs, in this order:

1. 1
   do_action( load-widgets.php )actionline 2369 (+16 into the body)

   Fires early when editing the widgets displayed in sidebars.

2. 2
   do_action( widgets.php )actionline 2376 (+23 into the body)

   Fires early when editing the widgets displayed in sidebars.

3. 3
   do_action( sidebar_admin_setup )actionline 2379 (+26 into the body)

   Fires early before the Widgets administration screen loads, after scripts are enqueued.

4. 4
   do_action( delete_widget )actionline 2407 (+54 into the body)

   Fires immediately after a widget has been marked for deletion.

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_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
• __()Retrieves the translation of $text.
• wp_get_sidebars_widgets()Retrieves the full list of sidebars and their widget instance IDs.
• wp_set_sidebars_widgets()Sets the sidebar widget option to update sidebars.

Source code

View on Trac ↗View on GitHub ↗

2353function wp_ajax_save_widget() {2354	global $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_widget_updates;2355 2356	check_ajax_referer( 'save-sidebar-widgets', 'savewidgets' );2357 2358	if ( ! current_user_can( 'edit_theme_options' ) || ! isset( $_POST['id_base'] ) ) {2359		wp_die( -1 );2360	}2361 2362	unset( $_POST['savewidgets'], $_POST['action'] );2363 2364	/**2365	 * Fires early when editing the widgets displayed in sidebars.2366	 *2367	 * @since 2.8.02368	 */2369	do_action( 'load-widgets.php' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores2370 2371	/**2372	 * Fires early when editing the widgets displayed in sidebars.2373	 *2374	 * @since 2.8.02375	 */2376	do_action( 'widgets.php' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores2377 2378	/** This action is documented in wp-admin/widgets.php */2379	do_action( 'sidebar_admin_setup' );2380 2381	$id_base      = wp_unslash( $_POST['id_base'] );2382	$widget_id    = wp_unslash( $_POST['widget-id'] );2383	$sidebar_id   = $_POST['sidebar'];2384	$multi_number = ! empty( $_POST['multi_number'] ) ? (int) $_POST['multi_number'] : 0;2385	$settings     = isset( $_POST[ 'widget-' . $id_base ] ) && is_array( $_POST[ 'widget-' . $id_base ] ) ? $_POST[ 'widget-' . $id_base ] : false;2386	$error        = '<p>' . __( 'An error has occurred. Please reload the page and try again.' ) . '</p>';2387 2388	$sidebars = wp_get_sidebars_widgets();2389	$sidebar  = isset( $sidebars[ $sidebar_id ] ) ? $sidebars[ $sidebar_id ] : array();2390 2391	// Delete.2392	if ( isset( $_POST['delete_widget'] ) && $_POST['delete_widget'] ) {2393 2394		if ( ! isset( $wp_registered_widgets[ $widget_id ] ) ) {2395			wp_die( $error );2396		}2397 2398		$sidebar = array_diff( $sidebar, array( $widget_id ) );2399		$_POST   = array(2400			'sidebar'            => $sidebar_id,2401			'widget-' . $id_base => array(),2402			'the-widget-id'      => $widget_id,2403			'delete_widget'      => '1',2404		);2405 2406		/** This action is documented in wp-admin/widgets.php */2407		do_action( 'delete_widget', $widget_id, $sidebar_id, $id_base );2408 2409	} elseif ( $settings && preg_match( '/__i__|%i%/', key( $settings ) ) ) {2410		if ( ! $multi_number ) {2411			wp_die( $error );2412		}2413 2414		$_POST[ 'widget-' . $id_base ] = array( $multi_number => reset( $settings ) );2415		$widget_id                     = $id_base . '-' . $multi_number;2416		$sidebar[]                     = $widget_id;2417	}2418	$_POST['widget-id'] = $sidebar;2419 2420	foreach ( (array) $wp_registered_widget_updates as $name => $control ) {2421 2422		if ( $name === $id_base ) {2423			if ( ! is_callable( $control['callback'] ) ) {2424				continue;2425			}2426 2427			ob_start();2428				call_user_func_array( $control['callback'], $control['params'] );2429			ob_end_clean();2430			break;2431		}2432	}

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.9.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.