rest_pre_get_setting

Advertisement

Summery Summery

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

Syntax Syntax

apply_filters( 'rest_pre_get_setting', mixed $result, string $name, array $args )

Description 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.

Parameters 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.

Source Source

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

Advertisement

Changelog Changelog

Changelog
Version Description
4.7.0 Introduced.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.