pre_update_site_option_{$option}
云策文档标注
概述
pre_update_site_option_{$option} 是一个动态 Hook,用于在更新网络选项值之前进行过滤。它允许开发者拦截和修改特定网络选项的新值。
关键要点
- 这是一个动态 Hook,$option 部分对应选项名称,例如 pre_update_site_option_my_option。
- 参数包括 $value(新值)、$old_value(旧值)、$option(选项名称)和 $network_id(网络ID)。
- 主要用于 update_network_option() 函数中,以自定义网络选项的更新逻辑。
- 从 WordPress 4.7.0 版本开始添加了 $network_id 参数,4.4.0 版本添加了 $option 参数,最初在 3.0.0/2.9.0 版本引入。
代码示例
$value = apply_filters( "pre_update_site_option_{$option}", $value, $old_value, $option, $network_id );注意事项
- 确保 Hook 名称中的 $option 部分正确匹配目标选项,否则过滤可能不生效。
- 使用此 Hook 时,注意参数顺序和类型,以避免意外错误。
原文内容
Filters a specific network option before its value is updated.
Description
The dynamic portion of the hook name, $option, refers to the option name.
Parameters
$valuemixed-
New value of the network option.
$old_valuemixed-
Old value of the network option.
$optionstring-
Option name.
$network_idint-
ID of the network.
Source
$value = apply_filters( "pre_update_site_option_{$option}", $value, $old_value, $option, $network_id );