From 61a40366e6e8ab0fe3647fe96c64bde98fca79cd Mon Sep 17 00:00:00 2001
From: John Blackbourn <johnbillion@git.wordpress.org>
Date: Tue, 13 Oct 2015 21:30:41 +0000
Subject: [PATCH] Improve the docs for the `$expiration` parameter in
 `set_transient()`, `set_site_transient()`, and associated filters.

See #32246


git-svn-id: https://develop.svn.wordpress.org/trunk@35149 602fd350-edb4-49c9-b593-d223f7449a82
---
 src/wp-includes/option.php | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/src/wp-includes/option.php b/src/wp-includes/option.php
index 4ac5a16eae..38bce02be5 100644
--- a/src/wp-includes/option.php
+++ b/src/wp-includes/option.php
@@ -673,7 +673,7 @@ function get_transient( $transient ) {
  *                           172 characters or fewer in length.
  * @param mixed  $value      Transient value. Must be serializable if non-scalar.
  *                           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.
  */
 function set_transient( $transient, $value, $expiration = 0 ) {
@@ -702,7 +702,7 @@ function set_transient( $transient, $value, $expiration = 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 string $transient  Transient name.
 	 */
@@ -752,7 +752,7 @@ function set_transient( $transient, $value, $expiration = 0 ) {
 		 * @since 4.4.0 The `$transient` parameter was added.
 		 *
 		 * @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.
 		 */
 		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 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 );
 	}
@@ -1602,7 +1602,7 @@ function get_site_transient( $transient ) {
  * @param string $transient  Transient name. Expected to not be SQL-escaped. Must be
  *                           40 characters or fewer in length.
  * @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.
  */
 function set_site_transient( $transient, $value, $expiration = 0 ) {
@@ -1629,7 +1629,7 @@ function set_site_transient( $transient, $value, $expiration = 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 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
 		 *
 		 * @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.
 		 */
 		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 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 );
 	}