Changeset 51885

Timestamp:

10/04/2021 08:42:54 PM (4 years ago)

Author:

johnbillion

Message:

Docs: Miscellaneous inline documentation improvements, including:

• Document the post statuses global as an array of stdClass objects
• Document the taxonomies global as an array of WP_Taxonomy objects
• Document the return value of the post count functions as stdClass objects
• Fix some typos

See #53399

Location:

trunk/src/wp-includes

Files:

• class-wp-customize-nav-menus.php (modified) (1 diff)
• class-wp-query.php (modified) (1 diff)
• functions.php (modified) (1 diff)
• post.php (modified) (8 diffs)
• taxonomy.php (modified) (8 diffs)

trunk/src/wp-includes/class-wp-customize-nav-menus.php

@@ -1335 +1335 @@
      * @since 4.7.0
      *
-     * @global array $wp_post_statuses List of post statuses.
+     * @global stdClass[] $wp_post_statuses List of post statuses.
      */
     public function make_auto_draft_status_previewable() {

trunk/src/wp-includes/class-wp-query.php

@@ -3856 +3856 @@
      * @since 3.1.0
      *
-     * @global array $wp_taxonomies
+     * @global WP_Taxonomy[] $wp_taxonomies Registered taxonomies.
      *
      * @param string|string[]           $taxonomy Optional. Taxonomy slug or slugs to check against.

trunk/src/wp-includes/functions.php

@@ -1534 +1534 @@
  *
  * @param string $yn Character string containing either 'y' (yes) or 'n' (no).
- * @return bool True if yes, false on anything else.
+ * @return bool True if 'y', false on anything else.
  */
 function bool_from_yn( $yn ) {

trunk/src/wp-includes/post.php

@@ -950 +950 @@
  * @since 2.0.0
  *
- * @param int|WP_Post $post Optional. Post ID or post object. Defaults to global $post..
+ * @param int|WP_Post $post Optional. Post ID or post object. Defaults to global $post.
  * @return string|false Post status on success, false on failure.
  */
@@ -1078 +1078 @@
  * @since 3.0.0
  *
- * @global array $wp_post_statuses Inserts new post status object into the list
+ * @global stdClass[] $wp_post_statuses Inserts new post status object into the list
  *
  * @param string       $post_status Name of the post status.
@@ -1202 +1202 @@
  * @since 3.0.0
  *
- * @global array $wp_post_statuses List of post statuses.
+ * @global stdClass[] $wp_post_statuses List of post statuses.
  *
  * @see register_post_status()
  *
  * @param string $post_status The name of a registered post status.
- * @return object|null A post status object.
+ * @return stdClass|null A post status object.
  */
 function get_post_status_object( $post_status ) {
@@ -1224 +1224 @@
  * @since 3.0.0
  *
- * @global array $wp_post_statuses List of post statuses.
+ * @global stdClass[] $wp_post_statuses List of post statuses.
  *
  * @see register_post_status()
@@ -2818 +2818 @@
  * @param string $type Optional. Post type to retrieve count. Default 'post'.
  * @param string $perm Optional. 'readable' or empty. Default empty.
- * @return object Number of posts for each status.
+ * @return stdClass Number of posts for each status.
  */
 function wp_count_posts( $type = 'post', $perm = '' ) {
@@ -2871 +2871 @@
      * @since 3.7.0
      *
-     * @param object $counts An object containing the current post_type's post
-     *                       counts by status.
-     * @param string $type   Post type.
-     * @param string $perm   The permission to determine if the posts are 'readable'
-     *                       by the current user.
+     * @param stdClass $counts An object containing the current post_type's post
+     *                         counts by status.
+     * @param string   $type   Post type.
+     * @param string   $perm   The permission to determine if the posts are 'readable'
+     *                         by the current user.
      */
     return apply_filters( 'wp_count_posts', $counts, $type, $perm );
@@ -2894 +2894 @@
  * @param string|string[] $mime_type Optional. Array or comma-separated list of
  *                                   MIME patterns. Default empty.
- * @return object An object containing the attachment counts by mime type.
+ * @return stdClass An object containing the attachment counts by mime type.
  */
 function wp_count_attachments( $mime_type = '' ) {
@@ -2913 +2913 @@
      * @since 3.7.0
      *
-     * @param object          $counts    An object containing the attachment counts by
+     * @param stdClass        $counts    An object containing the attachment counts by
      *                                   mime type.
      * @param string|string[] $mime_type Array or comma-separated list of MIME patterns.

trunk/src/wp-includes/taxonomy.php

@@ -199 +199 @@
  * @since 3.0.0
  *
- * @global array $wp_taxonomies The registered taxonomies.
+ * @global WP_Taxonomy[] $wp_taxonomies The registered taxonomies.
  *
  * @param array  $args     Optional. An array of `key => value` arguments to match against the taxonomy objects.
@@ -232 +232 @@
  * @since 2.3.0
  *
- * @global array $wp_taxonomies The registered taxonomies.
+ * @global WP_Taxonomy[] $wp_taxonomies The registered taxonomies.
  *
  * @param string|string[]|WP_Post $object Name of the type of taxonomy object, or an object (row from posts)
@@ -273 +273 @@
  * @since 2.3.0
  *
- * @global array $wp_taxonomies The registered taxonomies.
+ * @global WP_Taxonomy[] $wp_taxonomies The registered taxonomies.
  *
  * @param string $taxonomy Name of taxonomy object to return.
@@ -299 +299 @@
  * @since 3.0.0
  *
- * @global array $wp_taxonomies The registered taxonomies.
+ * @global WP_Taxonomy[] $wp_taxonomies The registered taxonomies.
  *
  * @param string $taxonomy Name of taxonomy object.
@@ -357 +357 @@
  * @since 5.5.0 Introduced `default_term` argument.
  *
- * @global array $wp_taxonomies Registered taxonomies.
+ * @global WP_Taxonomy[] $wp_taxonomies Registered taxonomies.
  *
  * @param string       $taxonomy    Taxonomy key, must not exceed 32 characters.
@@ -508 +508 @@
  *
  * @global WP    $wp            Current WordPress environment instance.
- * @global array $wp_taxonomies List of taxonomies.
+ * @global WP_Taxonomy[] $wp_taxonomies List of taxonomies.
  *
  * @param string $taxonomy Taxonomy name.
@@ -685 +685 @@
  * @since 3.0.0
  *
- * @global array $wp_taxonomies The registered taxonomies.
+ * @global WP_Taxonomy[] $wp_taxonomies The registered taxonomies.
  *
  * @param string $taxonomy    Name of taxonomy object.
@@ -727 +727 @@
  * @since 3.7.0
  *
- * @global array $wp_taxonomies The registered taxonomies.
+ * @global WP_Taxonomy[] $wp_taxonomies The registered taxonomies.
  *
  * @param string $taxonomy    Name of taxonomy object.