Filters the value of a setting recognized by the REST API.
Description
Allow hijacking the setting value and overriding the built-in behavior by returning a non-null value. The returned value will be presented as the setting value instead.
Parameters
$resultmixed- Value to use for the requested setting. Can be a scalar matching the registered schema for the setting, or null to follow the default get_option() behavior.
$namestring- Setting name (as shown in REST API responses).
$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
$response[ $name ] = apply_filters( 'rest_pre_get_setting', null, $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.