Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-10-02 09:07:59 +02:00
Code Issues Projects Releases Wiki Activity

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

Browse Source 
Functions include:
* `get_taxonomy_last_changed()`
* `set_taxonomy_last_changed()`
* `post_taxonomy_is_fresh()`
* `taxonomy_hierarchy_is_fresh()`

Fixes #22526, #14485.

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


git-svn-id: http://core.svn.wordpress.org/trunk@27008 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-02-09 02:02:12 +00:00
parent 65f4497766
commit f481bcd2db
1 changed files with 26 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
wp-includes/taxonomy.php
View File

@ -3506,13 +3506,14 @@ function wp_check_term_hierarchy_for_loops( $parent, $term_id, $taxonomy ) {
} }
/** /**
* Retrieve the 'last_changed' value for the passed taxonomy. Retrieves * Retrieve the 'last_changed' value for the passed taxonomy.
* from cache, if present *
* Retrieves from cache, if present.
* *
* @since 3.9.0 * @since 3.9.0
* *
* @param string $taxonomy * @param string $taxonomy Taxonomy slug.
* @return int * @return int Unix timestamp with microseconds of the last taxonomy change.
*/ */
function get_taxonomy_last_changed( $taxonomy ) { function get_taxonomy_last_changed( $taxonomy ) {
$last_changed = wp_cache_get( 'last_changed', $taxonomy ); $last_changed = wp_cache_get( 'last_changed', $taxonomy );
@ -3524,12 +3525,12 @@ function get_taxonomy_last_changed( $taxonomy ) {
} }
/** /**
* Reset 'last_changed' for the passed taxonomy * Reset 'last_changed' time for the passed taxonomy.
* *
* @since 3.9.0 * @since 3.9.0
* *
* @param string $taxonomy * @param string $taxonomy Taxonomy slug.
* @return int * @return int Unix timestamp with microseconds of the last taxonomy change.
*/ */
function set_taxonomy_last_changed( $taxonomy ) { function set_taxonomy_last_changed( $taxonomy ) {
wp_cache_delete( 'last_changed', $taxonomy ); wp_cache_delete( 'last_changed', $taxonomy );
@ -3537,14 +3538,18 @@ function set_taxonomy_last_changed( $taxonomy ) {
} }
/** /**
* Determine if a post's cache for the passed taxonomy * Determine if a post's cache for the passed taxonomy is in sync.
* 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 * @since 3.9.0
* *
* @param int $id * @param int $id Post ID.
* @param string $taxonomy * @param string $taxonomy Taxonomy slug.
* @return boolean * @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 ) { function post_taxonomy_is_fresh( $id, $taxonomy ) {
$last_changed = get_taxonomy_last_changed( $taxonomy ); $last_changed = get_taxonomy_last_changed( $taxonomy );
@ -3557,14 +3562,18 @@ function post_taxonomy_is_fresh( $id, $taxonomy ) {
} }
/** /**
* Determine if a hierarchy's cache for the passed taxonomy * Determine if a hierarchy's cache for the passed taxonomy is in sync.
* 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 * @since 3.9.0
* *
* @param int $id * @param int $id Post ID.
* @param string $taxonomy * @param string $taxonomy Taxonomy slug.
* @return boolean * @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 ) { function taxonomy_hierarchy_is_fresh( $taxonomy ) {
$last_changed = get_taxonomy_last_changed( $taxonomy ); $last_changed = get_taxonomy_last_changed( $taxonomy );