Changeset 49926

Timestamp:

01/03/2021 09:55:04 PM (6 years ago)

Author:

johnbillion

Message:

Docs: Various docblock corrections particularly relating to boolean types.

See #51800

Location:

trunk/src

Files:

• wp-admin/includes/class-wp-community-events.php (modified) (1 diff)
• wp-admin/includes/dashboard.php (modified) (1 diff)
• wp-admin/includes/deprecated.php (modified) (1 diff)
• wp-admin/includes/image.php (modified) (1 diff)
• wp-admin/includes/translation-install.php (modified) (1 diff)
• wp-includes/category-template.php (modified) (1 diff)
• wp-includes/class-wp-hook.php (modified) (1 diff)
• wp-includes/class-wp-image-editor-imagick.php (modified) (1 diff)
• wp-includes/class-wp-metadata-lazyloader.php (modified) (2 diffs)
• wp-includes/comment.php (modified) (1 diff)
• wp-includes/formatting.php (modified) (1 diff)
• wp-includes/functions.php (modified) (1 diff)
• wp-includes/plugin.php (modified) (2 diffs)
• wp-includes/post.php (modified) (1 diff)
• wp-includes/user.php (modified) (1 diff)

trunk/src/wp-admin/includes/class-wp-community-events.php

@@ -40 +40 @@
          *
          * @param int        $user_id       WP user ID.
-         * @param bool|array $user_location Stored location data for the user.
-         *                                  false to pass no location;
-         *                                  array to pass a location {
+         * @param false|array $user_location {
+         *     Stored location data for the user. false to pass no location.
+         *
          *     @type string $description The name of the location
          *     @type string $latitude    The latitude in decimal degrees notation, without the degree

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

@@ -1539 +1539 @@
  * @since 3.0.0
  *
- * @return bool|null True if not multisite, user can't upload files, or the space check option is disabled.
+ * @return true|void True if not multisite, user can't upload files, or the space check option is disabled.
  */
 function wp_dashboard_quota() {

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

@@ -129 +129 @@
  * @param int $level         Optional. Number of levels deep to display. Default 0.
  * @param array $categories  Optional. Categories to include in the control. Default 0.
- * @return bool|null False if no categories were found.
+ * @return false|void False if no categories were found.
  */
 function wp_dropdown_cats( $currentcat = 0, $currentparent = 0, $parent = 0, $level = 0, $categories = 0 ) {

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

@@ -1015 +1015 @@
                  * @since 3.1.0
                  *
-                 * @param string       $image_url     Current image URL.
+                 * @param string|false $image_url     Current image URL.
                  * @param int          $attachment_id Attachment ID.
                  * @param string|int[] $size          Requested image size. Can be any registered image size name, or

trunk/src/wp-admin/includes/translation-install.php

@@ -30 +30 @@
          * @since 4.0.0
          *
-         * @param bool|array  $result The result object. Default false.
-         * @param string      $type   The type of translations being requested.
-         * @param object      $args   Translation API arguments.
+         * @param false|object $result The result object. Default false.
+         * @param string       $type   The type of translations being requested.
+         * @param object       $args   Translation API arguments.
          */
         $res = apply_filters( 'translations_api', false, $type, $args );

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

@@ -816 +816 @@
  *                                                'DESC' (descending), or 'RAND' (random). Default 'ASC'.
  *     @type int|bool $filter                     Whether to enable filtering of the final output
- *                                                via {@see 'wp_generate_tag_cloud'}. Default 1|true.
+ *                                                via {@see 'wp_generate_tag_cloud'}. Default 1.
  *     @type string   $topic_count_text           Nooped plural text from _n_noop() to supply to
  *                                                tag counts. Default null.

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

@@ -187 +187 @@
         /**
          * Checks if a specific action has been registered for this hook.
+         *
+         * When using the $function_to_check argument, this function may return a non-boolean value
+         * that evaluates to false (e.g. 0), so use the === operator for testing the return value.
          *
          * @since 4.7.0

trunk/src/wp-includes/class-wp-image-editor-imagick.php

@@ -292 +292 @@
          * @param string $filter_name Optional. The Imagick filter to use when resizing. Default 'FILTER_TRIANGLE'.
          * @param bool   $strip_meta  Optional. Strip all profiles, excluding color profiles, from the image. Default true.
-         * @return bool|WP_Error
+         * @return void|WP_Error
          */
         protected function thumbnail_image( $dst_w, $dst_h, $filter_name = 'FILTER_TRIANGLE', $strip_meta = true ) {

trunk/src/wp-includes/class-wp-metadata-lazyloader.php

@@ -71 +71 @@
          * @param string $object_type Type of object whose meta is to be lazy-loaded. Accepts 'term' or 'comment'.
          * @param array  $object_ids  Array of object IDs.
-         * @return bool|WP_Error True on success, WP_Error on failure.
+         * @return void|WP_Error WP_Error on failure.
          */
         public function queue_objects( $object_type, $object_ids ) {
@@ -111 +111 @@
          *
          * @param string $object_type Object type. Accepts 'comment' or 'term'.
-         * @return bool|WP_Error True on success, WP_Error on failure.
+         * @return void|WP_Error WP_Error on failure.
          */
         public function reset_queue( $object_type ) {

trunk/src/wp-includes/comment.php

@@ -2407 +2407 @@
          * @since 1.5.0
          *
-         * @param int         $comment_id     Comment ID.
-         * @param string|bool $comment_status Current comment status. Possible values include
-         *                                    'hold', 'approve', 'spam', 'trash', or false.
+         * @param int    $comment_id     Comment ID.
+         * @param string $comment_status Current comment status. Possible values include
+         *                               'hold', '0', 'approve', '1, 'spam', and 'trash'.
          */
         do_action( 'wp_set_comment_status', $comment->comment_ID, $comment_status );

trunk/src/wp-includes/formatting.php

@@ -5546 +5546 @@
  * @since 3.6.0
  *
- * @param string|string[] $value String or array of strings to unslash.
- * @return string|string[] Unslashed $value
+ * @param string|array $value String or array of strings to unslash.
+ * @return string|array Unslashed $value
  */
 function wp_unslash( $value ) {

trunk/src/wp-includes/functions.php

@@ -838 +838 @@
  * @param string|null $content Post content. If `null`, the `post_content` field from `$post` is used.
  * @param int|WP_Post $post    Post ID or post object.
- * @return null|bool Returns false if post is not found.
+ * @return void|false Returns false if post is not found.
  */
 function do_enclose( $content, $post ) {

trunk/src/wp-includes/plugin.php

@@ -134 +134 @@
  *                   hook is returned, or false if the function is not attached. When using the
  *                   $function_to_check argument, this function may return a non-boolean value
- *                   that evaluates to false (e.g.) 0, so use the === operator for testing the
+ *                   that evaluates to false (e.g. 0), so use the === operator for testing the
  *                   return value.
  */
@@ -567 +567 @@
  *                  hook is returned, or false if the function is not attached. When using the
  *                  $function_to_check argument, this function may return a non-boolean value
- *                  that evaluates to false (e.g.) 0, so use the === operator for testing the
+ *                  that evaluates to false (e.g. 0), so use the === operator for testing the
  *                  return value.
  */

trunk/src/wp-includes/post.php

@@ -6104 +6104 @@
          * @since 2.1.0
          *
-         * @param array|bool $data          Array of meta data for the given attachment, or false
-         *                                  if the object does not exist.
-         * @param int        $attachment_id Attachment post ID.
+         * @param array $data          Array of meta data for the given attachment.
+         * @param int   $attachment_id Attachment post ID.
          */
         return apply_filters( 'wp_get_attachment_metadata', $data, $attachment_id );

trunk/src/wp-includes/user.php

@@ -1538 +1538 @@
  *
  * @param object|WP_User $user User object or database row to be cached
- * @return bool|null Returns false on failure.
+ * @return false|void Returns false on failure.
  */
 function update_user_caches( $user ) {