rest_pre_update_setting

Filters whether to preempt a setting value update.

Description

apply_filters( 'rest_pre_update_setting', (bool) $false, (string) $name, (string) $request_name, (array) $args ); 

Allows hijacking the setting update logic and overriding the built-in behavior by returning true.

Parameters (4)

0. $false (bool) => false
Whether to override the default behavior for updating the value of a setting.
1. $name (string)
Setting name (as shown in REST API responses).
2. $request_name (string)
Updated setting value.
3. $args (array)
Arguments passed to register_setting() for this setting.

Usage

To run the hook, copy the example below.
  1. $false = apply_filters( 'rest_pre_update_setting', $false, $name, $request_name, $args ); 
  2.  
  3. if ( !empty( $false ) ) { 
  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_update_setting callback 
  2. function filter_rest_pre_update_setting( $false, $name, $request_name, $args ) { 
  3. // make filter magic happen here... 
  4. return $false
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'rest_pre_update_setting', 'filter_rest_pre_update_setting', 10, 4 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'rest_pre_update_setting', 'filter_rest_pre_update_setting', 10, 4 ); 

Defined (1)

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

/wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php  
  1. $updated = apply_filters( 'rest_pre_update_setting', false, $name, $request[ $name ], $args );