钩子文档

pre_site_option_{$option}

💡 云策文档标注

概述

pre_site_option_{$option} 是一个动态过滤器钩子,用于在获取网络选项值之前修改其值。通过返回非 false 的值,可以短路检索过程并直接返回该值。

关键要点

  • 这是一个动态钩子,$option 部分对应选项名称。
  • 返回非 false 值会短路 get_network_option() 的检索流程。
  • 参数包括 $pre_site_option(默认 false)、$option(选项名)、$network_id(网络ID)和 $default_value(默认值)。
  • 与 get_network_option() 函数关联,用于网络选项管理。

代码示例

$pre = apply_filters( "pre_site_option_{$option}", false, $option, $network_id, $default_value );

注意事项

  • $pre_site_option 参数不同于 $default_value,后者仅在选项不存在时用作后备值。
  • 版本变更:4.9.0 添加 $default_value 参数,4.7.0 添加 $network_id 参数,4.4.0 添加 $option 参数,最初在 2.9.0 引入。

📄 原文内容

Filters the value of an existing network option before it is retrieved.

Description

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

Returning a value other than false from the filter will short-circuit retrieval and return that value instead.

Parameters

$pre_site_optionmixed
The value to return instead of the option value. This differs from $default_value, which is used as the fallback value in the event the option doesn’t exist elsewhere in get_network_option() .
Default false (to skip past the short-circuit).
$optionstring
Option name.
$network_idint
ID of the network.
$default_valuemixed
The fallback value to return if the option does not exist.
Default false.

Source

$pre = apply_filters( "pre_site_option_{$option}", false, $option, $network_id, $default_value );

Changelog

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