Changeset 28676

Timestamp:

06/05/2014 03:33:30 PM (11 years ago)

Author:

SergeyBiryukov

Message:

Add a note about return value in case of an expired transient to get_transient() and get_site_transient().

props ruud@joyo.
fixes #28462.

File:

• trunk/src/wp-includes/option.php (modified) (3 diffs)

trunk/src/wp-includes/option.php

@@ -552 +552 @@
  * Get the value of a transient.
  *
- * If the transient does not exist or does not have a value, then the return value
- * will be false.
+ * If the transient does not exist, does not have a value, or has expired,
+ * then the return value will be false.
  *
  * @since 2.8.0
  *
- * @param string $transient Transient name. Expected to not be SQL-escaped
- * @return mixed Value of transient
+ * @param string $transient Transient name. Expected to not be SQL-escaped.
+ * @return mixed Value of transient.
  */
 function get_transient( $transient ) {
@@ -1288 +1288 @@
  * Get the value of a site transient.
  *
- * If the transient does not exist or does not have a value, then the return value
- * will be false.
+ * If the transient does not exist, does not have a value, or has expired,
+ * then the return value will be false.
  *
  * @since 2.9.0
@@ -1296 +1296 @@
  *
  * @param string $transient Transient name. Expected to not be SQL-escaped.
- * @return mixed Value of transient
+ * @return mixed Value of transient.
  */
 function get_site_transient( $transient ) {