pre_transient_{$transient} WordPress Filter Hook

The pre_transient_{$transient} hook is fired before the value of a transient is read from the database. It is useful for modifying the value of a transient before it is used by the application.

apply_filters( "pre_transient_{$transient}", mixed $pre_transient, string $transient ) #

Filters the value of an existing transient before it is retrieved.


Description

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

Returning a truthy value from the filter will effectively short-circuit retrieval and return the passed value instead.


Top ↑

Parameters

$pre_transient

(mixed)The default value to return if the transient does not exist. Any value other than false will short-circuit the retrieval of the transient, and return that value.

$transient

(string)Transient name.


Top ↑

Source

File: wp-includes/option.php

View on Trac



Top ↑

Changelog

Changelog
VersionDescription
4.4.0The $transient parameter was added
2.8.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More