get_transient()
Get the value of a transient (a temporary option).
If a website is using object cache, then transient will be retrieved from the existing cache, not from the wp_options table directly.
On multisite, transients will be retrieved from the options of the current site/blog.
Use set_site_transient or get_site_transient to set or get a transient option of the main site.
Return
Mixed
.
-
false — when the transient:
- does not exist
- does not have a value
- has expired
- Value of transient otherwise.
Note: the returned false
should be checked with the identity equality operator (===), and not with the usual double equality, because the value of the option can contain 0, an empty string or an empty array. For the same reason, you do not need to save false into the option value, save 0 instead, or put false in an array.
Usage
get_transient( $transient );
- $transient(string) (required)
- Transient name. Expected to not be SQL-escaped.
Examples
#1 Saving a current query to the transient
This example shows how to use get_transient(), set_transient() with WP_Query to save the current query to the transient.
This may come in handy to save heavyweight queries.
// Get the transient $special_query_results = get_transient( 'special_query_results' ); if ( false === $special_query_results ) { // The transient is empty so let's add it $special_query_results = new WP_Query( 'cat=5&order=random&tag=tech&post_meta_key=thumbnail' ); set_transient( 'special_query_results', $special_query_results ); } // Using $special_query_results as usual...
Changelog
Since 2.8.0 | Introduced. |