__return_null()
云策文档标注
概述
__return_null() 是一个 WordPress 核心函数，用于在过滤器中轻松返回 null 值。它简化了返回 null 的代码编写。
关键要点
- __return_null() 函数返回 null 值，常用于过滤器（filter）中作为回调函数。
- 该函数自 WordPress 3.4.0 版本引入，是核心函数的一部分。
- 函数名遵循 WordPress 命名约定，带有双下划线前缀，但可能触发代码规范警告。
代码示例
add_filter( 'example_filter', '__return_null' );
原文内容
Returns null.
Description
Useful for returning null to filters easily.
Source
function __return_null() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore,PHPCompatibility.FunctionNameRestrictions.ReservedFunctionNames.FunctionDoubleUnderscore
return null;
}
Changelog
| Version | Description |
|---|---|
| 3.4.0 | Introduced. |
Skip to note 2 content
Codex
Add a filter on `example_filter` that returns null.
add_filter( 'example_filter', '__return_null' );