Changeset 46660 for trunk/src/wp-includes/media.php

Timestamp:

11/05/2019 09:21:46 PM (6 years ago)

Author:

johnbillion

Message:

Docs: Improve documentation of known return types, plus other docs fixes.

See #48303

File:

• trunk/src/wp-includes/media.php (modified) (7 diffs)

trunk/src/wp-includes/media.php

@@ -846 +846 @@
 
 /**
- * Gets the available intermediate image sizes.
+ * Gets the available intermediate image size names.
  *
  * @since 3.0.0
  *
- * @return array Returns a filtered array of image size strings.
+ * @return string[] An array of image size names.
  */
 function get_intermediate_image_sizes() {
@@ -865 +865 @@
      * @since 2.5.0
      *
-     * @param array $default_sizes An array of intermediate image sizes. Defaults
-     *                             are 'thumbnail', 'medium', 'medium_large', 'large'.
+     * @param string[] $default_sizes An array of intermediate image size names. Defaults
+     *                                are 'thumbnail', 'medium', 'medium_large', 'large'.
      */
     return apply_filters( 'intermediate_image_sizes', $default_sizes );
@@ -2437 +2437 @@
  * @param WP_Post $attachment The current attachment, provided for context.
  * @param string  $context    Optional. The context. Accepts 'edit', 'display'. Default 'display'.
- * @return array Key/value pairs of field keys to labels.
+ * @return string[] Key/value pairs of field keys to labels.
  */
 function wp_get_attachment_id3_keys( $attachment, $context = 'display' ) {
@@ -3047 +3047 @@
  *                                     or 'objects' to return an array of taxonomy objects.
  *                                     Default is 'names'.
- * @return array Empty array on failure. List of taxonomies on success.
+ * @return string[]|WP_Taxonomy[] List of taxonomies or taxonomy names. Empty array on failure.
  */
 function get_attachment_taxonomies( $attachment, $output = 'names' ) {
@@ -3160 +3160 @@
  * @param int $max_width      The maximum allowed width.
  * @param int $max_height     The maximum allowed height.
- * @return array The maximum possible width and height based on the example ratio.
+ * @return int[] {
+ *     An array of maximum width and height values.
+ *
+ *     @type int $0 The maximum width in pixels.
+ *     @type int $1 The maximum height in pixels.
+ * }
  */
 function wp_expand_dimensions( $example_width, $example_height, $max_width, $max_height ) {
@@ -4227 +4232 @@
  *
  * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
- * @return array A list of a gallery's image srcs in order.
+ * @return string[] A list of a gallery's image srcs in order.
  */
 function get_post_gallery_images( $post = 0 ) {
@@ -4313 +4318 @@
  * @since 4.0.0
  *
- * @return array The relevant CSS file URLs.
+ * @return string[] The relevant CSS file URLs.
  */
 function wpview_media_sandbox_styles() {