钩子文档

site_option_{$option}

💡 云策文档标注

概述

site_option_{$option} 是一个 WordPress 过滤器钩子,用于修改现有网络选项的值。它允许开发者在获取网络选项时动态过滤其值。

关键要点

  • 这是一个动态钩子,$option 部分对应选项名称,例如 site_option_my_option。
  • 参数包括 $value(选项值)、$option(选项名称)和 $network_id(网络ID)。
  • 主要用于 get_network_option() 函数中,影响网络选项的检索结果。
  • 自 WordPress 2.9.0 引入,后续版本添加了 $option 和 $network_id 参数。

注意事项

  • 使用此钩子时需确保 $option 名称正确,以避免影响其他选项。
  • 注意 $network_id 参数在 4.7.0 版本添加,用于多站点环境中的特定网络。

📄 原文内容

Filters the value of an existing network option.

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

return apply_filters( "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.