From aed2535da94059a9a1a614676027d8b8a6630da4 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Fri, 26 Feb 2016 09:22:08 +0000 Subject: [PATCH] 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 --- src/wp-includes/post.php | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/wp-includes/post.php b/src/wp-includes/post.php index 729e13d5f4..4eed68d539 100644 --- a/src/wp-includes/post.php +++ b/src/wp-includes/post.php @@ -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 * if the post is untrashed. @@ -6087,9 +6087,10 @@ function _prime_post_caches( $ids, $update_term_cache = true, $update_meta_cache * For internal use. * * @since 4.5.0 + * @access private * * @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 ) { $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 * 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. * * @since 4.5.0 + * @access private * * @param WP_Post $post The post. */