Docs: Standardize summaries for two new internal functions used to handle suffixing trashed posts.

Also adds a notation of private access to each.

See #11863. See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@36726 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2016-02-26 09:22:08 +00:00
parent 15f3acfbf5
commit aed2535da9
1 changed files with 5 additions and 3 deletions

View File

@ -6079,7 +6079,7 @@ function _prime_post_caches( $ids, $update_term_cache = true, $update_meta_cache
} }
/** /**
* If any trashed posts have a given slug, add a suffix. * Adds a suffix if any trashed posts have a given slug.
* *
* Store its desired (i.e. current) slug so it can try to reclaim it * Store its desired (i.e. current) slug so it can try to reclaim it
* if the post is untrashed. * if the post is untrashed.
@ -6087,9 +6087,10 @@ function _prime_post_caches( $ids, $update_term_cache = true, $update_meta_cache
* For internal use. * For internal use.
* *
* @since 4.5.0 * @since 4.5.0
* @access private
* *
* @param string $post_name Slug. * @param string $post_name Slug.
* @param string $post__not_in Post ID that should be ignored. * @param string $post__not_in Optional. Post ID that should be ignored. Default 0.
*/ */
function wp_add_trashed_suffix_to_post_name_for_trashed_posts( $post_name, $post_ID = 0 ) { function wp_add_trashed_suffix_to_post_name_for_trashed_posts( $post_name, $post_ID = 0 ) {
$trashed_posts_with_desired_slug = get_posts( array( $trashed_posts_with_desired_slug = get_posts( array(
@ -6108,7 +6109,7 @@ function wp_add_trashed_suffix_to_post_name_for_trashed_posts( $post_name, $post
} }
/** /**
* For a given post, add a trashed suffix. * Adds a trashed suffix For a given post.
* *
* Store its desired (i.e. current) slug so it can try to reclaim it * Store its desired (i.e. current) slug so it can try to reclaim it
* if the post is untrashed. * if the post is untrashed.
@ -6116,6 +6117,7 @@ function wp_add_trashed_suffix_to_post_name_for_trashed_posts( $post_name, $post
* For internal use. * For internal use.
* *
* @since 4.5.0 * @since 4.5.0
* @access private
* *
* @param WP_Post $post The post. * @param WP_Post $post The post.
*/ */