rest_pre_get_setting

Filters the value of a setting recognized by the REST API.

Description

apply_filters( 'rest_pre_get_setting', (null) $null, (string) $name, (array) $args ); 

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 (3)

0. $null (null) => null
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.
1. $name (string)
Setting name (as shown in REST API responses).
2. $args (array)
Arguments passed to register_setting() for this setting.

Usage

To run the hook, copy the example below.
  1. $null = apply_filters( 'rest_pre_get_setting', $null, $name, $args ); 
  2.  
  3. if ( !empty( $null ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the rest_pre_get_setting callback 
  2. function filter_rest_pre_get_setting( $null, $name, $args ) { 
  3. // make filter magic happen here... 
  4. return $null
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'rest_pre_get_setting', 'filter_rest_pre_get_setting', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'rest_pre_get_setting', 'filter_rest_pre_get_setting', 10, 3 ); 

Defined (1)

The filter is defined in the following location(s).

/wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php  
  1. $response[ $name ] = apply_filters( 'rest_pre_get_setting', null, $name, $args );