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
$result
bool- Whether to override the default behavior for updating the value of a setting.
$name
string- Setting name (as shown in REST API responses).
$value
mixed- Updated setting value.
$args
array- Arguments passed to register_setting() for this setting.
More Arguments from register_setting( … $args )
Data used to describe the setting when registered.
type
stringThe type of data associated with this setting.
Valid values are'string'
,'boolean'
,'integer'
,'number'
,'array'
, and'object'
.label
stringA label of the data attached to this setting.description
stringA description of the data attached to this setting.sanitize_callback
callableA callback function that sanitizes the option’s value.show_in_rest
bool|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.default
mixedDefault 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.