钩子文档

update_option

💡 云策文档标注

概述

update_option 是一个 WordPress 钩子,在选项值更新前立即触发,允许开发者在更新过程中执行自定义代码。

关键要点

  • 钩子名称:update_option,在选项更新前触发。
  • 参数:$option(选项名称)、$old_value(旧值)、$value(新值)。
  • 源调用:do_action( 'update_option', $option, $old_value, $value )。
  • 相关函数:update_option() 用于更新已添加的选项值。
  • 版本历史:自 WordPress 2.9.0 引入。

代码示例

add_action( 'update_option', function( $option_name, $old_value, $value ) {
     // 自定义代码...
}, 10, 3 );

注意事项

用户贡献笔记提供了示例,如检查特定选项更新后运行代码,但需注意钩子名称和参数的正确使用。


📄 原文内容

Fires immediately before an option value is updated.

Parameters

$optionstring
Name of the option to update.
$old_valuemixed
The old option value.
$valuemixed
The new option value.

Source

do_action( 'update_option', $option, $old_value, $value );

Changelog

Version Description
2.9.0 Introduced.

User Contributed Notes

  1. Skip to note 4 content

    Check if an specific option updated then run my code

    function wpdocs_updated_option( $option_name, $old_value, $value ) {
    
    	if ( 'wpdocs_custom_option_name' === $option_name ) {
    		
    		// You can run your code here if option name is what I wanted ...
    
    		// Another check if value is what I want, then run code.
    		if ( 'yes' === $value ) {
    			// Run my code here ...
    		}
    
    	}
    
    }
    add_action( 'updated_option', 'wpdocs_updated_option', 10, 3 );