钩子文档

added_option

💡 云策文档标注

概述

added_option 是一个 WordPress Hook,在选项被添加后触发。它允许开发者在选项添加时执行自定义操作。

关键要点

  • 触发时机:在 add_option() 函数成功添加选项后立即执行。
  • 参数:$option(选项名称,字符串类型)和 $value(选项值,混合类型)。
  • 用途:常用于日志记录、缓存清理或与其他系统同步等操作。

代码示例

add_action( 'added_option', 'my_custom_function', 10, 2 );
function my_custom_function( $option, $value ) {
    // 自定义逻辑,例如记录日志或更新缓存
    error_log( "Option added: $option with value: " . print_r( $value, true ) );
}

注意事项

  • 此 Hook 仅在 add_option() 成功时触发,如果选项已存在或添加失败则不会触发。
  • 参数 $value 可以是任何类型,取决于添加的选项值,处理时需注意类型安全。
  • 从 WordPress 2.9.0 版本开始引入,确保兼容性。

📄 原文内容

Fires after an option has been added.

Parameters

$optionstring
Name of the added option.
$valuemixed
Value of the option.

Source

do_action( 'added_option', $option, $value );

Changelog

Version Description
2.9.0 Introduced.