apply_filters( 'rest_pre_update_setting', bool $result, string $name, mixed $value, array $args )

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

Description

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

Parameters

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

Source

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

View on Trac

Changelog

Version Description
4.7.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/hooks/rest_pre_update_setting