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.


Top ↑

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

Top ↑

Source

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

$response[ $name ] = apply_filters( 'rest_pre_get_setting', null, $name, $args );


Top ↑

Changelog

Changelog
Version Description
4.7.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.