WP_Customize_Widgets::wp_ajax_update_widget()

Description

Hooks fired · 3

3 hooks fire while WP_Customize_Widgets::wp_ajax_update_widget() runs, in this order:

1. 1
   do_action( load-widgets.php )actionline 1720 (+17 into the body)

   Fires early when editing the widgets displayed in sidebars.

2. 2
   do_action( widgets.php )actionline 1723 (+20 into the body)

   Fires early when editing the widgets displayed in sidebars.

3. 3
   do_action( sidebar_admin_setup )actionline 1726 (+23 into the body)

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

Uses · 12

• is_user_logged_in()Determines whether the current visitor is a logged in user.
• wp_die()Kills WordPress execution and displays HTML page with an error message.
• 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_send_json_error()Sends a JSON response back to an Ajax request, indicating failure.
• do_action()Calls the callback functions that have been added to an action hook.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_send_json_success()Sends a JSON response back to an Ajax request, indicating success.
• WP_Customize_Widgets::get_post_value()Retrieves an unslashed post value or return a default.
• WP_Customize_Widgets::parse_widget_id()Converts a widget ID into its id_base and number components.
• WP_Customize_Widgets::call_widget_update()Finds and invokes the widget update and control callbacks.
• WP_Customize_Widgets::sanitize_widget_js_instance()Converts a widget instance into JSON-representable format.

Source

View on Trac ↗View on GitHub ↗

1703	public function wp_ajax_update_widget() {1704 1705		if ( ! is_user_logged_in() ) {1706			wp_die( 0 );1707		}1708 1709		check_ajax_referer( 'update-widget', 'nonce' );1710 1711		if ( ! current_user_can( 'edit_theme_options' ) ) {1712			wp_die( -1 );1713		}1714 1715		if ( empty( $_POST['widget-id'] ) ) {1716			wp_send_json_error( 'missing_widget-id' );1717		}1718 1719		/** This action is documented in wp-admin/includes/ajax-actions.php */1720		do_action( 'load-widgets.php' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores1721 1722		/** This action is documented in wp-admin/includes/ajax-actions.php */1723		do_action( 'widgets.php' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores1724 1725		/** This action is documented in wp-admin/widgets-form.php */1726		do_action( 'sidebar_admin_setup' );1727 1728		$widget_id = $this->get_post_value( 'widget-id' );1729		$parsed_id = $this->parse_widget_id( $widget_id );1730		$id_base   = $parsed_id['id_base'];1731 1732		$is_updating_widget_template = (1733			isset( $_POST[ 'widget-' . $id_base ] )1734			&&1735			is_array( $_POST[ 'widget-' . $id_base ] )1736			&&1737			preg_match( '/__i__|%i%/', key( $_POST[ 'widget-' . $id_base ] ) )1738		);1739		if ( $is_updating_widget_template ) {1740			wp_send_json_error( 'template_widget_not_updatable' );1741		}1742 1743		$updated_widget = $this->call_widget_update( $widget_id ); // => {instance,form}1744		if ( is_wp_error( $updated_widget ) ) {1745			wp_send_json_error( $updated_widget->get_error_code() );1746		}1747 1748		$form     = $updated_widget['form'];1749		$instance = $this->sanitize_widget_js_instance( $updated_widget['instance'], $id_base );1750 1751		wp_send_json_success( compact( 'form', 'instance' ) );1752	}

History

Introduced in 3.9.0. One change between 6.7.7 and 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 7.0.4 tag, from src/wp-includes/class-wp-customize-widgets.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.