钩子文档

pre_add_site_option_{$option}

💡 云策文档标注

概述

pre_add_site_option_{$option} 是一个动态过滤器钩子,用于在添加网络选项之前过滤其值。它允许开发者在选项被存储前修改或验证数据。

关键要点

  • 这是一个动态钩子,$option 部分对应选项名称,例如 pre_add_site_option_my_option。
  • 参数包括 $value(选项值)、$option(选项名称)和 $network_id(网络ID)。
  • 钩子通过 apply_filters 调用,常用于 add_network_option() 函数中。
  • 版本历史:$network_id 参数在 4.7.0 添加,$option 参数在 4.4.0 添加,钩子自 3.0.0/2.9.0 引入。

代码示例

$value = apply_filters( "pre_add_site_option_{$option}", $value, $option, $network_id );

注意事项

使用此钩子时,确保 $option 名称正确,以避免影响其他选项。注意参数类型:$value 为 mixed,$option 为 string,$network_id 为 int。


📄 原文内容

Filters the value of a specific network option before it is added.

Description

The dynamic portion of the hook name, $option, refers to the option name.

Parameters

$valuemixed
Value of network option.
$optionstring
Option name.
$network_idint
ID of the network.

Source

$value = apply_filters( "pre_add_site_option_{$option}", $value, $option, $network_id );

Changelog

Version Description
4.7.0 The $network_id parameter was added.
4.4.0 The $option parameter was added.
3.0.0
2.9.0 Introduced.