钩子文档

default_option_{$option}

💡 云策文档标注

概述

default_option_{$option} 是一个动态过滤器钩子,用于在选项不存在于数据库时过滤其默认返回值。它允许开发者在 get_option() 调用中自定义选项的默认值。

关键要点

  • 这是一个动态钩子,$option 部分对应具体选项名称,例如 default_option_my_option。
  • 钩子参数包括 $default_value(默认值)、$option(选项名)和 $passed_default(指示是否传递了默认值)。
  • 主要用于 get_option() 函数,当选项未在数据库中找到时,应用此过滤器返回自定义默认值。
  • 从 WordPress 4.7.0 开始添加 $passed_default 参数,以区分 false 值和默认参数值。

相关函数

  • update_option():更新已存在选项的值。
  • add_option():添加新选项。
  • get_option():基于选项名检索选项值,是此钩子的主要应用场景。

📄 原文内容

Filters the default value for an option.

Description

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

Parameters

$default_valuemixed
The default value to return if the option does not exist in the database.
$optionstring
Option name.
$passed_defaultbool
Was get_option() passed a default value?

Source

return apply_filters( "default_option_{$option}", $default_value, $option, $passed_default );

Changelog

Version Description
4.7.0 The $passed_default parameter was added to distinguish between a false value and the default parameter value.
4.4.0 The $option parameter was added.
3.4.0 Introduced.