Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-06-29 08:15:01 +02:00
Code Issues Projects Releases Wiki Activity

Improve the docs for the $expiration parameter in set_transient(), set_site_transient(), and associated filters.

Browse Source 
See #32246

Built from https://develop.svn.wordpress.org/trunk@35149


git-svn-id: http://core.svn.wordpress.org/trunk@35115 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn 2015-10-13 21:31:25 +00:00
parent a2a4bdcb9d
commit 537ac4c2ec
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
wp-includes/option.php
View File

@ -673,7 +673,7 @@ function get_transient( $transient ) {
* 172 characters or fewer in length. * 172 characters or fewer in length.
* @param mixed $value Transient value. Must be serializable if non-scalar. * @param mixed $value Transient value. Must be serializable if non-scalar.
* Expected to not be SQL-escaped. * Expected to not be SQL-escaped.
* @param int $expiration Optional. Time until expiration in seconds. Default 0. * @param int $expiration Optional. Time until expiration in seconds. Default 0 (no expiration).
* @return bool False if value was not set and true if value was set. * @return bool False if value was not set and true if value was set.
*/ */
function set_transient( $transient, $value, $expiration = 0 ) { function set_transient( $transient, $value, $expiration = 0 ) {
@ -702,7 +702,7 @@ function set_transient( $transient, $value, $expiration = 0 ) {
* *
* @since 4.4.0 * @since 4.4.0
* *
* @param int $expiration Time until expiration in seconds. * @param int $expiration Time until expiration in seconds. Use 0 for no expiration.
* @param mixed $value New value of transient. * @param mixed $value New value of transient.
* @param string $transient Transient name. * @param string $transient Transient name.
*/ */
@ -752,7 +752,7 @@ function set_transient( $transient, $value, $expiration = 0 ) {
* @since 4.4.0 The `$transient` parameter was added. * @since 4.4.0 The `$transient` parameter was added.
* *
* @param mixed $value Transient value. * @param mixed $value Transient value.
* @param int $expiration Time until expiration in seconds. Default 0. * @param int $expiration Time until expiration in seconds.
* @param string $transient The name of the transient. * @param string $transient The name of the transient.
*/ */
do_action( 'set_transient_' . $transient, $value, $expiration, $transient ); do_action( 'set_transient_' . $transient, $value, $expiration, $transient );
@ -765,7 +765,7 @@ function set_transient( $transient, $value, $expiration = 0 ) {
* *
* @param string $transient The name of the transient. * @param string $transient The name of the transient.
* @param mixed $value Transient value. * @param mixed $value Transient value.
* @param int $expiration Time until expiration in seconds. Default 0. * @param int $expiration Time until expiration in seconds.
*/ */
do_action( 'setted_transient', $transient, $value, $expiration ); do_action( 'setted_transient', $transient, $value, $expiration );
} }
@ -1602,7 +1602,7 @@ function get_site_transient( $transient ) {
* @param string $transient Transient name. Expected to not be SQL-escaped. Must be * @param string $transient Transient name. Expected to not be SQL-escaped. Must be
* 40 characters or fewer in length. * 40 characters or fewer in length.
* @param mixed $value Transient value. Expected to not be SQL-escaped. * @param mixed $value Transient value. Expected to not be SQL-escaped.
* @param int $expiration Optional. Time until expiration in seconds. Default 0. * @param int $expiration Optional. Time until expiration in seconds. Default 0 (no expiration).
* @return bool False if value was not set and true if value was set. * @return bool False if value was not set and true if value was set.
*/ */
function set_site_transient( $transient, $value, $expiration = 0 ) { function set_site_transient( $transient, $value, $expiration = 0 ) {
@ -1629,7 +1629,7 @@ function set_site_transient( $transient, $value, $expiration = 0 ) {
* *
* @since 4.4.0 * @since 4.4.0
* *
* @param int $expiration Time until expiration in seconds. * @param int $expiration Time until expiration in seconds. Use 0 for no expiration.
* @param mixed $value New value of site transient. * @param mixed $value New value of site transient.
* @param string $transient Transient name. * @param string $transient Transient name.
*/ */
@ -1661,7 +1661,7 @@ function set_site_transient( $transient, $value, $expiration = 0 ) {
* @since 4.4.0 The `$transient` parameter was added * @since 4.4.0 The `$transient` parameter was added
* *
* @param mixed $value Site transient value. * @param mixed $value Site transient value.
* @param int $expiration Time until expiration in seconds. Default 0. * @param int $expiration Time until expiration in seconds.
* @param string $transient Transient name. * @param string $transient Transient name.
*/ */
do_action( 'set_site_transient_' . $transient, $value, $expiration, $transient ); do_action( 'set_site_transient_' . $transient, $value, $expiration, $transient );
@ -1673,7 +1673,7 @@ function set_site_transient( $transient, $value, $expiration = 0 ) {
* *
* @param string $transient The name of the site transient. * @param string $transient The name of the site transient.
* @param mixed $value Site transient value. * @param mixed $value Site transient value.
* @param int $expiration Time until expiration in seconds. Default 0. * @param int $expiration Time until expiration in seconds.
*/ */
do_action( 'setted_site_transient', $transient, $value, $expiration ); do_action( 'setted_site_transient', $transient, $value, $expiration );
} }

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.4-alpha-35148'; $wp_version = '4.4-alpha-35149';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.