Changeset 46315 for trunk/src/wp-admin/includes/template.php

Timestamp:

09/26/2019 12:56:36 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for _post_states() and get_post_states().

Add documentation for _media_states().

See #47110.

File:

• trunk/src/wp-admin/includes/template.php (modified) (3 diffs)

trunk/src/wp-admin/includes/template.php

@@ -2063 +2063 @@
 
 /**
- * Function to echo or return the Post States as HTML.
+ * Function to echo or return the post states as HTML.
  *
  * @since 2.7.0
- * @since 5.3.0 Adopted use of get_post_states
+ * @since 5.3.0 Added the `$echo` parameter and a return value.
+ *
+ * @see get_post_states()
  *
  * @param WP_Post $post The post to retrieve states for.
- * @param boolean $echo Optional. Whether to echo or return the Post States as an HTML string. Default true for echo.
- *
- * @return string|void Post States string when echo is false.
+ * @param bool    $echo Optional. Whether to echo the post states as an HTML string. Default true.
+ * @return string Post states string.
  */
 function _post_states( $post, $echo = true ) {
@@ -2097 +2098 @@
 
 /**
- * Function to retrieve an array of Post States from a Post.
+ * Function to retrieve an array of post states from a post.
  *
  * @since 5.3.0
  *
  * @param WP_Post $post The post to retrieve states for.
- *
- * @return array $post_states The array of translated post states.
- *
+ * @return array The array of translated post states.
  */
 function get_post_states( $post ) {
@@ -2171 +2170 @@
 
 /**
- * @param WP_Post $post
+ * Function to echo the attachment media states as HTML.
+ *
+ * @since 3.2.0
+ *
+ * @param WP_Post $post The attachment post to retrieve states for.
+ * @return string Media states string.
  */
 function _media_states( $post ) {