Filters whether to preempt a setting value update via the REST API.

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

$result bool

Whether to override the default behavior for updating the value of a setting.

$name string

Setting name (as shown in REST API responses).

$value mixed

Updated setting value.

$args array

Arguments passed to register_setting() for this setting.

More Arguments from register_setting( ... $args )

Data used to describe the setting when registered.

• typestring
  The type of data associated with this setting.
  Valid values are 'string', 'boolean', 'integer', 'number', 'array', and 'object'.
• descriptionstring
  A description of the data attached to this setting.
• sanitize_callbackcallable
  A callback function that sanitizes the option's value.
• show_in_restbool|array
  Whether data associated with this setting should be included in the REST API.
  When registering complex settings, this argument may optionally be an array with a 'schema' key.
• defaultmixed
  Default value when calling get_option().

File: wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php. View all references

$updated = apply_filters( 'rest_pre_update_setting', false, $name, $request[ $name ], $args );