Changeset 27141

Timestamp:

02/09/2014 02:01:28 AM (11 years ago)

Author:

DrewAPicture

Message:

Improve inline documentation for several 'last_changed'-related functions introduced in [27101] and [27102].

Functions include:

• get_taxonomy_last_changed()
• set_taxonomy_last_changed()
• post_taxonomy_is_fresh()
• taxonomy_hierarchy_is_fresh()

Fixes #22526, #14485.

File:

• trunk/src/wp-includes/taxonomy.php (modified) (4 diffs)

trunk/src/wp-includes/taxonomy.php

@@ -3507 +3507 @@
 
 /**
- * Retrieve the 'last_changed' value for the passed taxonomy. Retrieves
- *  from cache, if present
+ * Retrieve the 'last_changed' value for the passed taxonomy.
+ *
+ * Retrieves from cache, if present.
  *
  * @since 3.9.0
  *
- * @param string $taxonomy
- * @return int
+ * @param string $taxonomy Taxonomy slug.
+ * @return int Unix timestamp with microseconds of the last taxonomy change.
  */
 function get_taxonomy_last_changed( $taxonomy ) {
@@ -3525 +3526 @@
 
 /**
- * Reset 'last_changed' for the passed taxonomy
+ * Reset 'last_changed' time for the passed taxonomy.
  *
  * @since 3.9.0
  *
- * @param string $taxonomy
- * @return int
+ * @param string $taxonomy Taxonomy slug.
+ * @return int Unix timestamp with microseconds of the last taxonomy change.
  */
 function set_taxonomy_last_changed( $taxonomy ) {
@@ -3538 +3539 @@
 
 /**
- * Determine if a post's cache for the passed taxonomy
- *  is in sync.
+ * Determine if a post's cache for the passed taxonomy is in sync.
+ *
+ * 'Fresh'-ness is determined based on whether the 'last_changed'
+ * times of the passed post and taxonomy are in sync. Times are
+ * stored as Unix timestamps with microseconds.
  *
  * @since 3.9.0
  *
- * @param int $id
- * @param string $taxonomy
- * @return boolean
+ * @param int    $id       Post ID.
+ * @param string $taxonomy Taxonomy slug.
+ * @return bool True if the 'last_changed' times are in sync, or 'fresh'.
+ *              False if they are out of sync, or not cached.
  */
 function post_taxonomy_is_fresh( $id, $taxonomy ) {
@@ -3558 +3563 @@
 
 /**
- * Determine if a hierarchy's cache for the passed taxonomy
- *  is in sync.
+ * Determine if a hierarchy's cache for the passed taxonomy is in sync.
+ *
+ * 'Fresh'-ness is determined based on whether the 'last_changed' times
+ * of the passed taxonomy and its hierarchy are in sync. Times are
+ * stored as Unix timestamps with microseconds.
  *
  * @since 3.9.0
  *
- * @param int $id
- * @param string $taxonomy
- * @return boolean
+ * @param int    $id       Post ID.
+ * @param string $taxonomy Taxonomy slug.
+ * @return bool True if the 'last_changed' times are in sync, or 'fresh'.
+ *              False if they are out of sync, or not cached.
  */
 function taxonomy_hierarchy_is_fresh( $taxonomy ) {