Filter hook 'rest_pre_get_setting'
in WP Core File wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php at line 98
Description
Filters the value of a setting recognized by the REST API. 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.
Occurrences
Filename |
Line Number |
wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php |
98 |
Parameters
Type |
Name |
Description |
mixed |
$result |
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. |
string |
$name |
Setting name (as shown in REST API responses). |
array |
$args |
Arguments passed to register_setting() for this setting. |
PHP Doc
/**
* Filters the value of a setting recognized by the REST API.
*
* 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.
*
* @since 4.7.0
*
* @param mixed $result 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.
* @param string $name Setting name (as shown in REST API responses).
* @param array $args Arguments passed to register_setting() for this setting.
*/