W3cubDocs

/WordPress

wp_ajax_delete_inactive_widgets()

Ajax handler for removing inactive widgets.

Source

File: wp-admin/includes/ajax-actions.php 

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();
}

Uses

Uses Description
wp-admin/includes/ajax-actions.php: load-widgets.php

Fires early when editing the widgets displayed in sidebars.
wp-admin/includes/ajax-actions.php: widgets.php

Fires early when editing the widgets displayed in sidebars.
wp-admin/widgets.php: sidebar_admin_setup

Fires early before the Widgets administration screen loads, after scripts are enqueued.
wp-includes/capabilities.php: current_user_can()

Returns whether the current user has the specified capability.
wp-includes/pluggable.php: check_ajax_referer()

Verifies the Ajax request to prevent processing requests external of the blog.
wp-includes/functions.php: wp_die()

Kills WordPress execution and displays HTML page with an error message.
wp-includes/plugin.php: do_action()

Execute functions hooked on a specific action hook.
wp-includes/option.php: update_option()

Updates the value of an option that was already added.
wp-includes/option.php: get_option()

Retrieves an option value based on an option name.
wp-includes/widgets.php: wp_get_sidebars_widgets()

Retrieve full list of sidebars and their widget instance IDs.
wp-includes/widgets.php: wp_set_sidebars_widgets()

Set the sidebar widget option to update sidebars.

Changelog

Version Description
4.4.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_ajax_delete_inactive_widgets