钩子文档

customize_dynamic_setting_args

💡 云策文档标注

概述

本文档介绍 customize_dynamic_setting_args 过滤器,用于过滤动态设置的构造函数参数,确保其能被正确注册。

关键要点

  • 过滤器用于覆盖动态设置的默认 false 值,提供 WP_Customize_Setting 构造函数所需的参数数组。
  • 参数包括 $setting_args(false 或数组)和 $setting_id(动态设置的 ID,通常来自 $_POST['customized'])。
  • 在 WP_Customize_Manager::add_dynamic_settings() 中调用,以注册动态创建的设置。

代码示例

$setting_args = apply_filters( 'customize_dynamic_setting_args', $setting_args, $setting_id );

注意事项

  • 此过滤器自 WordPress 4.2.0 版本引入。
  • 动态设置通常来自 $_POST['customized'],需要此过滤器才能正确注册。

📄 原文内容

Filters a dynamic setting’s constructor args.

Description

For a dynamic setting to be registered, this filter must be employed to override the default false value with an array of args to pass to the WP_Customize_Setting constructor.

Parameters

$setting_argsfalse|array
The arguments to the WP_Customize_Setting constructor.
$setting_idstring
ID for dynamic setting, usually coming from $_POST['customized'].

Source

$setting_args = apply_filters( 'customize_dynamic_setting_args', $setting_args, $setting_id );

Changelog

Version Description
4.2.0 Introduced.