apply_filters( 'rest_pre_update_setting', bool $result, string $name, mixed $value, array $args )
- Since
- 4.7.0
Filters whether to preempt a setting value update via the REST API.
Description
Allows hijacking the setting update logic and overriding the built-in behavior by returning true.
Compatibility
- WordPress
- since 4.7.0
- 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).
Parameters
$resultbool- Whether to override the default behavior for updating the value of a setting.
$namestring- Setting name (as shown in REST API responses).
$valuemixed- Updated setting value.
$argsarray- Arguments passed to register_setting() for this setting.
Where this hook fires · 1
wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php:169WP_REST_Settings_Controller::update_item()
Source code
* @param bool $result Whether to override the default behavior for updating the * value of a setting. * @param string $name Setting name (as shown in REST API responses). * @param mixed $value Updated setting value. * @param array $args Arguments passed to register_setting() for this setting. */ $updated = apply_filters( 'rest_pre_update_setting', false, $name, $request[ $name ], $args ); if ( $updated ) { continue; } /*Changelog
Introduced in 4.7.0. Unchanged from 6.7.7 through 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, 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.