rest_pre_get_setting filter-hook . WP 4.7.0
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.
Usage
add_filter( 'rest_pre_get_setting', 'filter_function_name_1659', 10, 3 ); function filter_function_name_1659( $result, $name, $args ){ // filter... return $result; }
- $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.
Changelog
Since 4.7.0 | Introduced. |
Where the hook is called
rest_pre_get_setting
wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php 99
$response[ $name ] = apply_filters( 'rest_pre_get_setting', null, $name, $args );