钩子文档

customize_dynamic_partial_args

💡 云策文档标注

概述

本文档介绍 customize_dynamic_partial_args 过滤器,用于过滤动态 partial 的构造函数参数。开发者需使用此过滤器将默认的 false 值替换为数组,以注册动态 partial。

关键要点

  • 过滤器名称:customize_dynamic_partial_args
  • 作用:过滤动态 partial 的构造函数参数,必须返回数组以覆盖默认 false 值
  • 参数:$partial_args(false 或数组,WP_Customize_Partial 构造函数参数)和 $partial_id(字符串,动态 partial 的 ID)
  • 相关函数:WP_Customize_Selective_Refresh::add_dynamic_partials() 和 WP_Customize_Selective_Refresh::add_partial()
  • 引入版本:WordPress 4.5.0

代码示例

$partial_args = apply_filters( 'customize_dynamic_partial_args', $partial_args, $partial_id );

📄 原文内容

Filters a dynamic partial’s constructor arguments.

Description

For a dynamic partial 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_Partial constructor.

Parameters

$partial_argsfalse|array
The arguments to the WP_Customize_Partial constructor.
$partial_idstring
ID for dynamic partial.

Source

$partial_args = apply_filters( 'customize_dynamic_partial_args', $partial_args, $partial_id );

Changelog

Version Description
4.5.0 Introduced.