云策 WordPress 开发者社区

钩子文档

customize_post_value_set

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

概述

本文档介绍 WordPress 自定义器中的 customize_post_value_set 钩子，它在设置未清理的 POST 值被设置时触发，主要用于 WP_Customize_Setting 实例更新缓存预览值。

关键要点

  • 钩子名称：customize_post_value_set
  • 触发时机：当 WP_Customize_Manager::set_post_value() 方法被调用时
  • 主要用途：允许 WP_Customize_Setting 实例监听以更新缓存预览值
  • 参数：$setting_id（字符串，设置 ID）、$value（混合类型，未清理的设置 POST 值）、$manager（WP_Customize_Manager 实例）
  • 相关函数：WP_Customize_Manager::set_post_value() 用于覆盖当前自定义状态中的设置值
  • 版本历史：自 WordPress 4.4.0 引入

代码示例

do_action( 'customize_post_value_set', $setting_id, $value, $this );
📄 原文内容

Announces when any setting’s unsanitized post value has been set.

Description

Fires when the WP_Customize_Manager::set_post_value() method is called.

This is useful for WP_Customize_Setting instances to watch in order to update a cached previewed value.

Parameters

$setting_idstring
Setting ID.
$valuemixed
Unsanitized setting post value.
$managerWP_Customize_Manager
WP_Customize_Manager instance.

Source

do_action( 'customize_post_value_set', $setting_id, $value, $this );

View all references View on Trac View on GitHub

Used by Description
WP_Customize_Manager::set_post_value()wp-includes/class-wp-customize-manager.php

Overrides a setting’s value in the current customized state.

Changelog

Version Description
4.4.0 Introduced.