云策 WordPress 开发者社区

钩子文档

customize_sanitize_{$this->id}

查看官方原文 ↗
💡 云策文档标注

概述

customize_sanitize_{$this->id} 是一个 WordPress 过滤器钩子，用于在未转义形式下过滤 Customize 设置的值。它允许开发者在设置值被保存前进行自定义清理或验证。

关键要点

  • 过滤器名称：customize_sanitize_{$this->id}，其中 {$this->id} 是动态部分，对应特定设置的 ID。
  • 参数：$value（设置的值，mixed 类型）和 $setting（WP_Customize_Setting 实例）。
  • 用途：主要用于 sanitize 方法中，如 WP_Customize_Setting::sanitize() 和相关子类。
  • 引入版本：WordPress 3.4.0。

代码示例

apply_filters( "customize_sanitize_{$this->id}", $value, $this );
📄 原文内容

Filters a Customize setting value in un-slashed form.

Parameters

$valuemixed
Value of the setting.
$settingWP_Customize_Setting
WP_Customize_Setting instance.

Source

return apply_filters( "customize_sanitize_{$this->id}", $value, $this );

View all references View on Trac View on GitHub

Used by Description
WP_Customize_Nav_Menu_Setting::sanitize()wp-includes/customize/class-wp-customize-nav-menu-setting.php

Sanitize an input.
WP_Customize_Nav_Menu_Item_Setting::sanitize()wp-includes/customize/class-wp-customize-nav-menu-item-setting.php

Sanitize an input.
WP_Customize_Setting::sanitize()wp-includes/class-wp-customize-setting.php

Sanitize an input.

Changelog

Version Description
3.4.0 Introduced.