rest_pre_get_setting WordPress Filter Hook
The "rest_pre_get_setting" hook is called before retrieving a setting from the REST API. This hook can be used to modify the setting before it is retrieved.
apply_filters( 'rest_pre_get_setting', mixed $result , string $name , array $args ) #
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
- $result
(mixed)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.
- $name
(string)Setting name (as shown in REST API responses).
- $args
(array)Arguments passed to register_setting() for this setting.
Source
File: wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php
Changelog
| Version | Description |
|---|---|
| 4.7.0 | Introduced. |