set_transient( string $transient, mixed $value, int $expiration = 0 ): bool

Description

Parameters

$transientstring

Transient name. Expected to not be SQL-escaped. Must be 172 characters or fewer in length.

$valuemixed

Transient value. Must be serializable if non-scalar. Expected to not be SQL-escaped.

$expirationintoptional

Time until expiration in seconds. Default 0 (no expiration).Default: 0

Return

bool

True if the value was set, false otherwise.

Hooks fired · 4

4 hooks fire while set_transient() runs, in this order:

1. 1
   apply_filters( pre_set_transient_{$transient} )filterline 1517 (+17 into the body)

   Filters a specific transient before its value is set.

2. 2
   apply_filters( expiration_of_transient_{$transient} )filterline 1530 (+30 into the body)

   Filters the expiration for a transient before its value is set.

3. 3
   do_action( set_transient_{$transient} )actionline 1585 (+85 into the body)

   Fires after the value for a specific transient has been set.

4. 4
   do_action( setted_transient )actionline 1597 (+97 into the body)

   Fires after the value for a transient has been set.

Uses · 10

• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_using_ext_object_cache()Toggles `$_wp_using_ext_object_cache` on and off without directly touching global.
• wp_installing()Checks or sets whether WordPress is in "installation" mode.
• wp_cache_set()Saves the data to the cache.
• wp_prime_option_caches()Primes specific options into the cache with a single database query.
• get_option()Retrieves an option value based on an option name.
• add_option()Adds a new option.
• delete_option()Removes an option by name. Prevents removal of protected WordPress options.
• update_option()Updates the value of an option that was already added.
• do_action()Calls the callback functions that have been added to an action hook.

Used by · 24

• Featured_Content::get_featured_post_ids()Get featured post IDs
• RSSCache::set()
• WP_Automatic_Updater::has_fatal_error()Performs a loopback request to check for potential fatal errors.
• WP_Feed_Cache_Transient::save()Saves data to the transient.
• WP_Feed_Cache_Transient::touch()Sets mod transient.
• WP_Site_Health::wp_cron_scheduled_check()Runs the scheduled event to check and update the latest site health status for the website.
• WP_oEmbed_Controller::get_proxy_item()Callback for the proxy API endpoint.
• clean_dirsize_cache()Cleans directory size cache used by recurse_dirsize().
• install_themes_feature_list()Retrieves the list of WordPress theme features (aka theme tags).
• is_multi_author()Determines whether this site has more than one author.
• recurse_dirsize()Gets the size of a directory recursively.
• register_core_block_style_handles()Registers core block style handles.

Source

View on Trac ↗View on GitHub ↗

1500function set_transient( $transient, $value, $expiration = 0 ) {1501 1502	$expiration = (int) $expiration;1503 1504	/**1505	 * Filters a specific transient before its value is set.1506	 *1507	 * The dynamic portion of the hook name, `$transient`, refers to the transient name.1508	 *1509	 * @since 3.0.01510	 * @since 4.2.0 The `$expiration` parameter was added.1511	 * @since 4.4.0 The `$transient` parameter was added.1512	 *1513	 * @param mixed  $value      New value of transient.1514	 * @param int    $expiration Time until expiration in seconds.1515	 * @param string $transient  Transient name.1516	 */1517	$value = apply_filters( "pre_set_transient_{$transient}", $value, $expiration, $transient );1518 1519	/**1520	 * Filters the expiration for a transient before its value is set.1521	 *1522	 * The dynamic portion of the hook name, `$transient`, refers to the transient name.1523	 *1524	 * @since 4.4.01525	 *1526	 * @param int    $expiration Time until expiration in seconds. Use 0 for no expiration.1527	 * @param mixed  $value      New value of transient.1528	 * @param string $transient  Transient name.1529	 */1530	$expiration = apply_filters( "expiration_of_transient_{$transient}", $expiration, $value, $transient );1531 1532	if ( wp_using_ext_object_cache() || wp_installing() ) {1533		$result = wp_cache_set( $transient, $value, 'transient', $expiration );1534	} else {1535		$transient_timeout = '_transient_timeout_' . $transient;1536		$transient_option  = '_transient_' . $transient;1537		wp_prime_option_caches( array( $transient_option, $transient_timeout ) );1538 1539		if ( false === get_option( $transient_option ) ) {1540			$autoload = true;1541			if ( $expiration ) {1542				$autoload = false;1543				add_option( $transient_timeout, time() + $expiration, '', false );1544			}1545			$result = add_option( $transient_option, $value, '', $autoload );1546		} else {1547			/*1548			 * If expiration is requested, but the transient has no timeout option,1549			 * delete, then re-create transient rather than update.1550			 */1551			$update = true;1552 1553			if ( $expiration ) {1554				if ( false === get_option( $transient_timeout ) ) {1555					delete_option( $transient_option );1556					add_option( $transient_timeout, time() + $expiration, '', false );1557					$result = add_option( $transient_option, $value, '', false );1558					$update = false;1559				} else {1560					update_option( $transient_timeout, time() + $expiration );1561				}1562			}1563 1564			if ( $update ) {1565				$result = update_option( $transient_option, $value );1566			}1567		}1568	}1569 1570	if ( $result ) {1571 1572		/**1573		 * Fires after the value for a specific transient has been set.1574		 *1575		 * The dynamic portion of the hook name, `$transient`, refers to the transient name.1576		 *1577		 * @since 3.0.01578		 * @since 3.6.0 The `$value` and `$expiration` parameters were added.1579		 * @since 4.4.0 The `$transient` parameter was added.

History

Introduced in 2.8.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/option.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.