wppaste
WordPress

WP_Widget_Media::update( array $new_instance, array $old_instance ): array

Since
4.8.0, 5.9.0
Source
wp-includes/widgets/class-wp-widget-media.php:277
Sanitizes the widget form values as they are saved.

Compatibility

WordPress
since 5.9.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$new_instancearray
Values just sent to be saved.
$old_instancearray
Previously saved values from database.

Return value

array
Updated safe values to be saved.

Performance profile

How much work a call to WP_Widget_Media::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
Heavy

Reaches the database via WP_Widget_Media::update().

Scaling
Scales with input

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

Instructions
8–9

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

  • sqldatabase queryWP_Widget_Media::update()this function does it
  • hookthird-party callbacksdo_action()one call below WP_Widget_Media::update()

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

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

WhenInstructionsCalls it makes
always8–9->get_instance_schema()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 50 instructions, 8–9 executed per call, 9 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 4

Source code

	public function update( $new_instance, $old_instance ) { 		$schema = $this->get_instance_schema();		foreach ( $schema as $field => $field_schema ) {			if ( ! array_key_exists( $field, $new_instance ) ) {				continue;			}			$value = $new_instance[ $field ]; 			/*			 * Workaround for rest_validate_value_from_schema() due to the fact that			 * rest_is_boolean( '' ) === false, while rest_is_boolean( '1' ) is true.			 */			if ( 'boolean' === $field_schema['type'] && '' === $value ) {				$value = false;			} 			if ( true !== rest_validate_value_from_schema( $value, $field_schema, $field ) ) {				continue;			} 			$value = rest_sanitize_value_from_schema( $value, $field_schema ); 			// @codeCoverageIgnoreStart			if ( is_wp_error( $value ) ) {				continue; // Handle case when rest_sanitize_value_from_schema() ever returns WP_Error as its phpdoc @return tag indicates.			} 			// @codeCoverageIgnoreEnd			if ( isset( $field_schema['sanitize_callback'] ) ) {				$value = call_user_func( $field_schema['sanitize_callback'], $value );			}			if ( is_wp_error( $value ) ) {				continue;			}			$old_instance[ $field ] = $value;		} 		return $old_instance;	}

Changelog

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

5.9.0
Renamed $instance to $old_instance to match parent class for PHP 8 named parameter support.from the docblock
4.8.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/widgets/class-wp-widget-media.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.