WP_Customize_Widgets::call_widget_update( string $widget_id ): array|WP_Error

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$widget_idstring

Widget ID.

Return value

array|WP_Error

Array containing the updated widget information.
A WP_Error object, otherwise.

Performance profile

How much work a call to WP_Customize_Widgets::call_widget_update() 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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

40–158

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• serializeserialisationjson_decode()called directly

What one call costs · 76 distinct outcomes

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

Uses · 13

• did_action()Retrieves the number of times an action has been fired during the current request.
• wp_slash()Adds slashes to a string or recursively adds slashes to strings within an array.
• WP_Customize_Widgets::get_setting_id()Converts a widget_id into its corresponding Customizer setting ID (option name).
• WP_Customize_Widgets::start_capturing_option_updates()Begins keeping track of changes to widget options, caching new values.
• WP_Customize_Widgets::parse_widget_id()Converts a widget ID into its id_base and number components.
• WP_Customize_Widgets::get_post_value()Retrieves an unslashed post value or return a default.
• WP_Customize_Widgets::stop_capturing_option_updates()Undoes any changes to the options since options capture began.
• WP_Error::__construct()Initializes the error.
• WP_Customize_Widgets::sanitize_widget_instance()Sanitizes a widget instance.
• WP_Customize_Widgets::count_captured_options()Retrieves the number of captured widget option updates.
• WP_Customize_Widgets::get_captured_options()Retrieves captured widget option updates.
• WP_Customize_Widgets::get_captured_option()Retrieves the option that was captured from being saved.

Used by · 1

• WP_Customize_Widgets::wp_ajax_update_widget()Updates widget settings asynchronously.

Source code

View on Trac ↗View on GitHub ↗

1577	public function call_widget_update( $widget_id ) {1578		global $wp_registered_widget_updates, $wp_registered_widget_controls;1579 1580		$setting_id = $this->get_setting_id( $widget_id );1581 1582		/*1583		 * Make sure that other setting changes have previewed since this widget1584		 * may depend on them (e.g. Menus being present for Navigation Menu widget).1585		 */1586		if ( ! did_action( 'customize_preview_init' ) ) {1587			foreach ( $this->manager->settings() as $setting ) {1588				if ( $setting->id !== $setting_id ) {1589					$setting->preview();1590				}1591			}1592		}1593 1594		$this->start_capturing_option_updates();1595		$parsed_id   = $this->parse_widget_id( $widget_id );1596		$option_name = 'widget_' . $parsed_id['id_base'];1597 1598		/*1599		 * If a previously-sanitized instance is provided, populate the input vars1600		 * with its values so that the widget update callback will read this instance1601		 */1602		$added_input_vars = array();1603		if ( ! empty( $_POST['sanitized_widget_setting'] ) ) {1604			$sanitized_widget_setting = json_decode( $this->get_post_value( 'sanitized_widget_setting' ), true );1605			if ( false === $sanitized_widget_setting ) {1606				$this->stop_capturing_option_updates();1607				return new WP_Error( 'widget_setting_malformed' );1608			}1609 1610			$instance = $this->sanitize_widget_instance( $sanitized_widget_setting, $parsed_id['id_base'] );1611			if ( is_null( $instance ) ) {1612				$this->stop_capturing_option_updates();1613				return new WP_Error( 'widget_setting_unsanitized' );1614			}1615 1616			if ( ! is_null( $parsed_id['number'] ) ) {1617				$value                         = array();1618				$value[ $parsed_id['number'] ] = $instance;1619				$key                           = 'widget-' . $parsed_id['id_base'];1620				$_REQUEST[ $key ]              = wp_slash( $value );1621				$_POST[ $key ]                 = $_REQUEST[ $key ];1622				$added_input_vars[]            = $key;1623			} else {1624				foreach ( $instance as $key => $value ) {1625					$_REQUEST[ $key ]   = wp_slash( $value );1626					$_POST[ $key ]      = $_REQUEST[ $key ];1627					$added_input_vars[] = $key;1628				}1629			}1630		}1631 1632		// Invoke the widget update callback.1633		foreach ( (array) $wp_registered_widget_updates as $name => $control ) {1634			if ( $name === $parsed_id['id_base'] && is_callable( $control['callback'] ) ) {1635				ob_start();1636				call_user_func_array( $control['callback'], $control['params'] );1637				ob_end_clean();1638				break;1639			}1640		}1641 1642		// Clean up any input vars that were manually added.1643		foreach ( $added_input_vars as $key ) {1644			unset( $_POST[ $key ] );1645			unset( $_REQUEST[ $key ] );1646		}1647 1648		// Make sure the expected option was updated.1649		if ( 0 !== $this->count_captured_options() ) {1650			if ( $this->count_captured_options() > 1 ) {1651				$this->stop_capturing_option_updates();1652				return new WP_Error( 'widget_setting_too_many_options' );1653			}1654 1655			$updated_option_name = key( $this->get_captured_options() );1656			if ( $updated_option_name !== $option_name ) {

Changelog

Introduced in 3.9.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 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.