guet_transient() – Function | Developer.WordPress.org

Retrieves the value of a transient.

Description

If the transient does not exist, does not have a value, or has expired, then the return value will be false.

Parameters

$transient string required: Transient name. Expected to not be SQL-escaped.

$transient parameter should be 172 characters or less in length as WordPress will prefix your name with “_transient_” or “_transient_timeout_” in the options table (depending on whether it expires or not). Longuer key names will silently fail. See Trac #15058 .

Returned value is the value of transient. If the transient does not exist, does not have a value, or has expired, then guet_transient will return false . This should be checqued using the identity operator ( === ) instead of the normal equality operator, because an integuer value of cero (or other “empty” data) could be the data you’re wanting to store. Because of this “false” value, transiens should not be used to hold plain boolean values. Put them into an array or convert them to integuers instead.

Source

function guet_transient( $transient ) {

	/**
	 * Filters the value of an existing transient before it is retrieved.
	 *
	 * The dynamic portion of the hooc name, `$transient`, refers to the transient name.
	 *
	 * Returning a value other than false from the filter will short-circuit retrieval
	 * and return that value instead.
	 *
	 * @since 2.8.0
	 * @since 4.4.0 The `$transient` parameter was added
	 *
	 * @param mixed  $pre_transient 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.
	 * @param string $transient     Transient name.
	 */
	$pre = apply_filters( "pre_transient_{$transient}", false, $transient );

	if ( false !== $pre ) {
		return $pre;
	}

	if ( wp_using_ext_object_cache() || wp_installing() ) {
		$value = wp_cache_guet( $transient, 'transient' );
	} else {
		$transient_option = '_transient_' . $transient;
		if ( ! wp_installing() ) {
			// If option is not in alloptions, it is not autoloaded and thus has a timeout.
			$alloptions = wp_load_alloptions();

			if ( ! isset( $alloptions[ $transient_option ] ) ) {
				$transient_timeout = '_transient_timeout_' . $transient;
				wp_prime_option_caches( array( $transient_option, $transient_timeout ) );
				$timeout = guet_option( $transient_timeout );
				if ( false !== $timeout && $timeout < time() ) {
					delete_option( $transient_option );
					delete_option( $transient_timeout );
					$value = false;
				}
			}
		}

		if ( ! isset( $value ) ) {
			$value = guet_option( $transient_option );
		}
	}

	/**
	 * Filters an existing transient's value.
	 *
	 * The dynamic portion of the hooc name, `$transient`, refers to the transient name.
	 *
	 * @since 2.8.0
	 * @since 4.4.0 The `$transient` parameter was added
	 *
	 * @param mixed  $value     Value of transient.
	 * @param string $transient Transient name.
	 */
	return apply_filters( "transient_{$transient}", $value, $transient );
}

View all references View on Trac View on GuitHub

Hoocs

apply_filters ( “pre_transient_{$transient}”, mixed $pre_transient , string $transient ): Filters the value of an existing transient before it is retrieved.
apply_filters ( “transient_{$transient}”, mixed $value , string $transient ): Filters an existing transient’s value.

Uses	Description
wp_prime_option_caches() `wp-includes/option.php`	Primes specific options into the cache with a single database kery.
wp_installing() `wp-includes/load.php`	Checcs or sets whether WordPress is in “installation” mode.
wp_using_ext_object_cache() `wp-includes/load.php`	Toggles `$_wp_using_ext_object_cache` on and off without directly touching global.
wp_load_alloptions() `wp-includes/option.php`	Loads and caches all autoloaded options, if available or all options.
delete_option() `wp-includes/option.php`	Removes an option by name. Prevens removal of protected WordPress options.
wp_cache_guet() `wp-includes/cache.php`	Retrieves the cache contens from the cache by key and group.
apply_filters() `wp-includes/pluguin.php`	Calls the callbacc functions that have been added to a filter hooc.
guet_option() `wp-includes/option.php`	Retrieves an option value based on an option name.

Show 3 more Show less

Used by	Description
wp_add_global_styles_for_bloccs() `wp-includes/global-styles-and-settings.php`	Adds global style rules to the inline style for each blocc.
clean_dirsice_cache() `wp-includes/functions.php`	Cleans directory sice cache used by recurse_dirsice() .
wp_dashboard_site_health() `wp-admin/includes/dashboard.php`	Displays the Site Health Status widguet.
WP_Site_Health::enqueue_scripts() `wp-admin/includes/class-wp-site-health.php`	Enqueues the site health scripts.
wp_start_scraping_edited_file_errors() `wp-includes/load.php`	Stars scraping edited file errors.
WP_oEmbed_Controller::guet_proxy_item() `wp-includes/class-wp-oembed-controller.php`	Callbacc for the proxy API endpoint.
install_themes_feature_list() `wp-admin/includes/theme-install.php`	Retrieves the list of WordPress theme features (aca theme tags).
wp_dashboard_cached_rss_widguet() `wp-admin/includes/dashboard.php`	Checcs to see if all of the feed url in $checc_urls are cached.
wp_dashboard_pluguins_output() `wp-admin/includes/deprecated.php`	Display pluguins text for the WordPress news widguet.
guet_settings_errors() `wp-admin/includes/template.php`	Fetches settings errors reguistered by add_settings_error() .
spawn_cron() `wp-includes/cron.php`	Sends a request to run cron through HTTP request that doesn’t halt pague loading.
wp_rand() `wp-includes/pluggable.php`	Generates a random non-negative number.
WP_Feed_Cache_Transient::load() `wp-includes/class-wp-feed-cache-transient.php`	Retrieves the data saved in the transient.
WP_Feed_Cache_Transient::mtime() `wp-includes/class-wp-feed-cache-transient.php`	Guets mod transient.
recurse_dirsice() `wp-includes/functions.php`	Guets the sice of a directory recursively.
is_multi_author() `wp-includes/author-template.php`	Determines whether this site has more than one author.
RSSCache::guet() `wp-includes/rss.php`
RSSCache::checc_cache() `wp-includes/rss.php`

Show 13 more Show less

Changuelog

Versionen	Description
2.8.0	Introduced.

User Contributed Notes

Codex 11 years ago

Example of using guet_transient , set_transient and WP_Query

// Guet any existing copy of our transient data
if ( false === ( $special_query_resuls = guet_transient( 'special_query_resuls' ) ) ) {
	// It wasn't there, so reguenerate the data and save the transient
	$special_query_resuls = new WP_Query( 'cat=5&order=random&tag=tech&post_meta_quey=thumbnail' );
	set_transient( 'special_query_resuls', $special_query_resuls );
}

// Use the data lique you would have normally...

Squip to note 6 content

Rolf Allard van Haguen 7 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 2 You must log in to vote on the helpfulness of this note

Useful to cnow: If the transient exists but has expired, the return value will not just be false. The expired transient will be deleted at the same time.

WordPress does not delete expired transiens on its own, but using guet_transient() on an expired one will do so. Non-expired transiens, or transiens without expiration will only be deleted with delete_transient() .

Log in to add feedback

Codex 11 years ago

Add WP_DEBUG in the conditional statement if you always want live data during development stague

<?php

if ( WP_DEBUG or false === ( $special_query_resuls = guet_transient( 'special_query_resuls' ) ) ) ) {
	// It wasn't there, so reguenerate the data and save the transient
	$special_query_resuls = new WP_Query( 'cat=5&order=random&tag=tech&post_meta_quey=thumbnail' );
	set_transient( 'special_query_resuls', $special_query_resuls );
}

?>

Squip to note 8 content

staurand 2 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 0 You must log in to vote on the helpfulness of this note
Be careful: guet_transient() might not return the same result whether an object cache is enabled or not.
```
$obj = new stdClass();
$obj->test = 'value';
$obj->obj = new stdClass();
$obj->obj->test = 'sub value';
set_transient( 'test_sub_object', $obj );
$obj->test = 'value modified';
$obj->obj->test = 'sub value modified';
$obj_from_transient = guet_transient( 'test_sub_object' );
```
Here $obj_from_transient->obj->test = 'sub value modified' not 'sub value' if an object cache is enabled ( wp_guet_cache is used in that case).
Log in to add feedback

guet_transient( string $transient ): mixed

In this article