WP_REST_Settings_Controller::update_item( WP_REST_Request $request ): array|WP_Error

Compatibility

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

Parameters

$requestWP_REST_Request

Full details about the request.

Return value

array|WP_Error

Array on success, or error object on failure.

Performance profile

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

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Scales with input

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

Instructions

13–56

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

Plugin surface

1 hook

Third-party callbacks on 'rest_pre_update_setting' 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 callbacksapply_filters()called directly
• optionoption read or writeget_option()called directly
• cacheobject cachewp_cache_get()one call below WP_REST_Settings_Controller::update_item()
• serializeserialisationmaybe_unserialize()one call below WP_REST_Settings_Controller::update_item()

Further down the call graph this can also reach 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 · 2 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while WP_REST_Settings_Controller::update_item() runs, in this order:

1. 1
   apply_filters( rest_pre_update_setting )filterline 169 (+24 into the body)

   Filters whether to preempt a setting value update via the REST API.

Uses · 10

• apply_filters()Calls the callback functions that have been added to a filter hook.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• rest_validate_value_from_schema()Validate a value based on a schema.
• get_option()Retrieves an option value based on an option name.
• __()Retrieves the translation of $text.
• delete_option()Removes an option by name. Prevents removal of protected WordPress options.
• update_option()Updates the value of an option that was already added.
• WP_REST_Settings_Controller::get_registered_options()Retrieves all of the registered options for the Settings API.
• WP_Error::__construct()Initializes the error.
• WP_REST_Settings_Controller::get_item()Retrieves the settings.

Source code

View on Trac ↗View on GitHub ↗

145	public function update_item( $request ) {146		$options = $this->get_registered_options();147 148		$params = $request->get_params();149 150		foreach ( $options as $name => $args ) {151			if ( ! array_key_exists( $name, $params ) ) {152				continue;153			}154 155			/**156			 * Filters whether to preempt a setting value update via the REST API.157			 *158			 * Allows hijacking the setting update logic and overriding the built-in behavior by159			 * returning true.160			 *161			 * @since 4.7.0162			 *163			 * @param bool   $result Whether to override the default behavior for updating the164			 *                       value of a setting.165			 * @param string $name   Setting name (as shown in REST API responses).166			 * @param mixed  $value  Updated setting value.167			 * @param array  $args   Arguments passed to register_setting() for this setting.168			 */169			$updated = apply_filters( 'rest_pre_update_setting', false, $name, $request[ $name ], $args );170 171			if ( $updated ) {172				continue;173			}174 175			/*176			 * A null value for an option would have the same effect as177			 * deleting the option from the database, and relying on the178			 * default value.179			 */180			if ( is_null( $request[ $name ] ) ) {181				/*182				 * A null value is returned in the response for any option183				 * that has a non-scalar value.184				 *185				 * To protect clients from accidentally including the null186				 * values from a response object in a request, we do not allow187				 * options with values that don't pass validation to be updated to null.188				 * Without this added protection a client could mistakenly189				 * delete all options that have invalid values from the190				 * database.191				 */192				if ( is_wp_error( rest_validate_value_from_schema( get_option( $args['option_name'], false ), $args['schema'] ) ) ) {193					return new WP_Error(194						'rest_invalid_stored_value',195						/* translators: %s: Property name. */196						sprintf( __( 'The %s property has an invalid stored value, and cannot be updated to null.' ), $name ),197						array( 'status' => 500 )198					);199				}200 201				delete_option( $args['option_name'] );202			} else {203				update_option( $args['option_name'], $request[ $name ] );204			}205		}206 207		return $this->get_item( $request );208	}

Changelog

Introduced in 4.7.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 6.8.8 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.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.