Sets/updates the value of a site transient.
Description
You do not need to serialize values. If the value needs to be serialized, then it will be serialized before it is set.
See also
Parameters
$transient
stringrequired- Transient name. Expected to not be SQL-escaped. Must be 167 characters or fewer in length.
$value
mixedrequired- Transient value. Expected to not be SQL-escaped.
$expiration
intoptional- Time until expiration in seconds. Default 0 (no expiration).
Source
function set_site_transient( $transient, $value, $expiration = 0 ) { /** * Filters the value of a specific site transient before it is set. * * The dynamic portion of the hook name, `$transient`, refers to the transient name. * * @since 3.0.0 * @since 4.4.0 The `$transient` parameter was added. * * @param mixed $value New value of site transient. * @param string $transient Transient name. */ $value = apply_filters( "pre_set_site_transient_{$transient}", $value, $transient ); $expiration = (int) $expiration; /** * Filters the expiration for a site transient before its value is set. * * The dynamic portion of the hook name, `$transient`, refers to the transient name. * * @since 4.4.0 * * @param int $expiration Time until expiration in seconds. Use 0 for no expiration. * @param mixed $value New value of site transient. * @param string $transient Transient name. */ $expiration = apply_filters( "expiration_of_site_transient_{$transient}", $expiration, $value, $transient ); if ( wp_using_ext_object_cache() || wp_installing() ) { $result = wp_cache_set( $transient, $value, 'site-transient', $expiration ); } else { $transient_timeout = '_site_transient_timeout_' . $transient; $option = '_site_transient_' . $transient; wp_prime_site_option_caches( array( $option, $transient_timeout ) ); if ( false === get_site_option( $option ) ) { if ( $expiration ) { add_site_option( $transient_timeout, time() + $expiration ); } $result = add_site_option( $option, $value ); } else { if ( $expiration ) { update_site_option( $transient_timeout, time() + $expiration ); } $result = update_site_option( $option, $value ); } } if ( $result ) { /** * Fires after the value for a specific site transient has been set. * * The dynamic portion of the hook name, `$transient`, refers to the transient name. * * @since 3.0.0 * @since 4.4.0 The `$transient` parameter was added * * @param mixed $value Site transient value. * @param int $expiration Time until expiration in seconds. * @param string $transient Transient name. */ do_action( "set_site_transient_{$transient}", $value, $expiration, $transient ); /** * Fires after the value for a site transient has been set. * * @since 6.8.0 * * @param string $transient The name of the site transient. * @param mixed $value Site transient value. * @param int $expiration Time until expiration in seconds. */ do_action( 'set_site_transient', $transient, $value, $expiration ); /** * Fires after the value for a site transient has been set. * * @since 3.0.0 * @deprecated 6.8.0 Use 'set_site_transient' instead. * * @param string $transient The name of the site transient. * @param mixed $value Site transient value. * @param int $expiration Time until expiration in seconds. */ do_action_deprecated( 'setted_site_transient', array( $transient, $value, $expiration ), '6.8.0', 'set_site_transient' ); } return $result; }
Hooks
- apply_filters( “expiration_of_site_transient_{$transient}”,
int $expiration ,mixed $value ,string $transient ) Filters the expiration for a site transient before its value is set.
- apply_filters( “pre_set_site_transient_{$transient}”,
mixed $value ,string $transient ) Filters the value of a specific site transient before it is set.
- do_action_deprecated( ‘setted_site_transient’,
string $transient ,mixed $value ,int $expiration ) Fires after the value for a site transient has been set.
- do_action( ‘set_site_transient’,
string $transient ,mixed $value ,int $expiration ) Fires after the value for a site transient has been set.
- do_action( “set_site_transient_{$transient}”,
mixed $value ,int $expiration ,string $transient ) Fires after the value for a specific site transient has been set.
Changelog
Version | Description |
---|---|
2.9.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.