wp_ajax_save_widget()

Hooks fired · 4

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

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

   Fires early when editing the widgets displayed in sidebars.

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

   Fires early when editing the widgets displayed in sidebars.

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

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

4. 4
   do_action( delete_widget )actionline 2404 (+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()Retrieve full list of sidebars and their widget instance IDs.
• wp_set_sidebars_widgets()Set the sidebar widget option to update sidebars.

Source

View on Trac ↗View on GitHub ↗

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

History

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.