Changeset 49021 for trunk/src/wp-admin/includes/post.php

Timestamp:

09/20/2020 04:21:42 PM (6 years ago)

Author:

johnbillion

Message:

Media: Standardise the description for image size parameters.

This brings continuity to all the image related functions and filters which accept or pass a size parameter.

Props dilipbheda, johnbillion

Fixes #47364

File:

• trunk/src/wp-admin/includes/post.php (modified) (1 diff)

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

@@ -1537 +1537 @@
          * Note: When a theme adds 'post-thumbnail' support, a special 'post-thumbnail'
          * image size is registered, which differs from the 'thumbnail' image size
-         * managed via the Settings > Media screen. See the `$size` parameter description
-         * for more information on default values.
+         * managed via the Settings > Media screen.
          *
          * @since 4.4.0
          *
-         * @param string|array $size         Post thumbnail image size to display in the meta box. Accepts any valid
-         *                                   image size, or an array of width and height values in pixels (in that order).
-         *                                   If the 'post-thumbnail' size is set, default is 'post-thumbnail'. Otherwise,
-         *                                   default is an array with 266 as both the height and width values.
+         * @param string|int[] $size         Requested image size. Can be any registered image size name, or
+         *                                   an array of width and height values in pixels (in that order).
          * @param int          $thumbnail_id Post thumbnail attachment ID.
          * @param WP_Post      $post         The post object associated with the thumbnail.