WP_Customize_Widgets::wp_ajax_update_widget()

Description

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_Customize_Widgets::wp_ajax_update_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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

64–94

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

Plugin surface

3 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

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

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

Hooks and filters 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 1717 (+17 into the body)

   Fires early when editing the widgets displayed in sidebars.

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

   Fires early when editing the widgets displayed in sidebars.

3. 3
   do_action( sidebar_admin_setup )actionline 1723 (+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 code

View on Trac ↗View on GitHub ↗

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

Changelog

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