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.
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.
More Arguments from register_setting( … $args )
Data used to describe the setting when registered.
typestringThe type of data associated with this setting.
Valid values are'string','boolean','integer','number','array', and'object'.labelstringA label of the data attached to this setting.descriptionstringA description of the data attached to this setting.sanitize_callbackcallableA callback function that sanitizes the option’s value.show_in_restbool|arrayWhether data associated with this setting should be included in the REST API.
When registering complex settings, this argument may optionally be an array with a'schema'key.defaultmixedDefault value when callingget_option().
Source
$updated = apply_filters( 'rest_pre_update_setting', false, $name, $request[ $name ], $args );
Changelog
| Version | Description |
|---|---|
| 4.7.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.