Changeset 36726

Timestamp:

02/26/2016 09:22:08 AM (9 years ago)

Author:

DrewAPicture

Message:

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.

File:

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

trunk/src/wp-includes/post.php

@@ -6080 +6080 @@
 
 /**
- * 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
@@ -6088 +6088 @@
  *
  * @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 ) {
@@ -6109 +6110 @@
 
 /**
- * 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
@@ -6117 +6118 @@
  *
  * @since 4.5.0
+ * @access private
  *
  * @param WP_Post $post The post.