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

Timestamp:

11/05/2019 09:28:51 PM (5 years ago)

Author:

johnbillion

Message:

Docs: Docs on docs. Further improve documentation of known return types, plus other docs fixes.

See #48303

File:

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

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

@@ -200 +200 @@
  *
  * @param string $taxonomy Taxonomy to retrieve terms from.
- * @param int $default Not used.
- * @param int $number Number of terms to retrieve. Defaults to 10.
- * @param bool $echo Optionally output the list as well. Defaults to true.
- * @return array List of popular term IDs.
+ * @param int    $default  Not used.
+ * @param int    $number   Number of terms to retrieve. Defaults to 10.
+ * @param bool   $echo     Optionally output the list as well. Defaults to true.
+ * @return int[] Array of popular term IDs.
  */
 function wp_popular_terms_checklist( $taxonomy, $default = 0, $number = 10, $echo = true ) {
@@ -2098 +2098 @@
 
 /**
- * Function to retrieve an array of post states from a post.
+ * Retrieves an array of post states from a post.
  *
  * @since 5.3.0
  *
  * @param WP_Post $post The post to retrieve states for.
- * @return array The array of translated post states.
+ * @return string[] Array of post state labels keyed by their state.
  */
 function get_post_states( $post ) {