钩子文档

pre_set_transient_{$transient}

💡 云策文档标注

概述

pre_set_transient_{$transient} 是一个动态过滤器钩子,用于在设置特定瞬态值之前拦截和修改其值。它允许开发者在瞬态保存到数据库前自定义处理逻辑。

关键要点

  • 这是一个动态钩子,钩子名称中的 $transient 部分对应瞬态名称,例如 pre_set_transient_my_transient。
  • 主要参数包括 $value(瞬态的新值)、$expiration(过期时间,以秒为单位)和 $transient(瞬态名称)。
  • 通过 apply_filters 调用,常用于 set_transient() 函数中,以修改瞬态值或添加额外逻辑。
  • 自 WordPress 3.0.0 引入,后续版本增加了 $expiration 和 $transient 参数。

📄 原文内容

Filters a specific transient before its value is set.

Description

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

Parameters

$valuemixed
New value of transient.
$expirationint
Time until expiration in seconds.
$transientstring
Transient name.

Source

$value = apply_filters( "pre_set_transient_{$transient}", $value, $expiration, $transient );

Changelog

Version Description
4.4.0 The $transient parameter was added.
4.2.0 The $expiration parameter was added.
3.0.0 Introduced.