rest_pre_update_setting WordPress Filter Hook

The rest_pre_update_setting hook is called before a setting is updated via the REST API. This hook allows you to modify the setting before it is saved to the database.

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.


Top ↑

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.


Top ↑

Source

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

View on Trac



Top ↑

Changelog

Changelog
VersionDescription
4.7.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.