rest_pre_get_setting

过滤钩子
apply_filters( 'rest_pre_get_setting', null, $name, $args )
参数
  • (mixed) $result 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.
    Required:
  • (string) $name Setting name (as shown in REST API responses).
    Required:
  • (array) $args Arguments passed to register_setting() for this setting.
    Required:
定义位置
相关勾子
rest_pre_update_settingregister_settingunregister_settingrest_prepare_statuspre_get_shortlink
相关方法
register_settingget_settingsunregister_settingregister_initial_settings__return_empty_stringrest_get_server
引入
4.7.0
弃用
-

rest_pre_get_setting – 这个钩子用于修改由REST API返回的单个设置的查询参数。每当通过REST API查询一个单一的设置,并在返回响应之前,这个钩子就会被触发。它为开发者提供了一种方法来修改被API查询的设置的查询参数。

过滤由 REST API 识别的设置的值。

允许劫持设置值,并通过返回一个非空值来覆盖内置行为。 返回的值将作为设置值呈现。

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

常见问题

FAQs
查看更多 >