WordPress.org
Get WordPress

Make WordPress Core

Changeset 54173


Ignore:
Timestamp:
09/15/2022 10:50:40 AM (2 years ago)
Author:
audrasjb
Message:

Docs: Use third-person singular verbs in Media API function descriptions, as per docblocks standards.

See #55646.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/media.php

    r54172 r54173  
    88
    99/**
    10  * Retrieve additional image sizes.
     10 * Retrieves additional image sizes.
    1111 *
    1212 * @since 4.7.0
    … …  
    2727
    2828/**
    29  * Scale down the default size of an image.
     29 * Scales down the default size of an image.
    3030 *
    3131 * This is so that the image is a better fit for the editor and theme.
    … …  
    137137
    138138/**
    139  * Retrieve width and height attributes using given width and height values.
     139 * Retrieves width and height attributes using given width and height values.
    140140 *
    141141 * Both attributes are required in the sense that both parameters must have a
    … …  
    165165
    166166/**
    167  * Scale an image to fit a particular size (such as 'thumb' or 'medium').
     167 * Scales an image to fit a particular size (such as 'thumb' or 'medium').
    168168 *
    169169 * The URL might be the original image, or it might be a resized version. This
    … …  
    273273
    274274/**
    275  * Register a new image size.
     275 * Registers a new image size.
    276276 *
    277277 * @since 2.9.0
    … …  
    300300
    301301/**
    302  * Check if an image size exists.
     302 * Checks if an image size exists.
    303303 *
    304304 * @since 3.9.0
    … …  
    313313
    314314/**
    315  * Remove a new image size.
     315 * Removes a new image size.
    316316 *
    317317 * @since 3.9.0
    … …  
    369369 * @param string|int[] $size  Optional. Image size. Accepts any registered image size name, or an array of
    370370 *                            width and height values in pixels (in that order). Default 'medium'.
    371  * @return string HTML IMG element for given image attachment
     371 * @return string HTML IMG element for given image attachment?
    372372 */
    373373function get_image_tag( $id, $alt, $title, $align, $size = 'medium' ) {
    … …  
    994994
    995995/**
    996  * Get an HTML img element representing an image attachment.
     996 * Gets an HTML img element representing an image attachment.
    997997 *
    998998 * While `$size` will accept an array, it is better to register a size with
    … …  
    11061106
    11071107    /**
    1108      * HTML img element representing an image attachment.
     1108     * Filters the HTML img element representing an image attachment.
    11091109     *
    11101110     * @since 5.6.0
    … …  
    11221122
    11231123/**
    1124  * Get the URL of an image attachment.
     1124 * Gets the URL of an image attachment.
    11251125 *
    11261126 * @since 4.4.0
    … …  
    11391139
    11401140/**
    1141  * Get the attachment path relative to the upload directory.
     1141 * Gets the attachment path relative to the upload directory.
    11421142 *
    11431143 * @since 4.4.1
    … …  
    11641164
    11651165/**
    1166  * Get the image size as array from its meta data.
     1166 * Gets the image size as array from its meta data.
    11671167 *
    11681168 * Used for responsive images.
    … …  
    12481248function wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attachment_id = 0 ) {
    12491249    /**
    1250      * Let plugins pre-filter the image meta to be able to fix inconsistencies in the stored data.
     1250     * Pre-filters the image meta to be able to fix inconsistencies in the stored data.
    12511251     *
    12521252     * @since 4.5.0
    … …  
    26632663
    26642664/**
    2665  * Outputs and enqueue default scripts and styles for playlists.
     2665 * Outputs and enqueues default scripts and styles for playlists.
    26662666 *
    26672667 * @since 3.9.0
    … …  
    37513751
    37523752/**
    3753  * Create new GD image resource with transparency support
     3753 * Creates new GD image resource with transparency support.
    37543754 *
    37553755 * @todo Deprecate if possible.
    … …  
    37763776
    37773777/**
    3778  * Based on a supplied width/height example, return the biggest possible dimensions based on the max width/height.
     3778 * Based on a supplied width/height example, returns the biggest possible dimensions based on the max width/height.
    37793779 *
    37803780 * @since 2.9.0
    … …  
    48114811
    48124812/**
    4813  * Check the content HTML for a audio, video, object, embed, or iframe tags.
     4813 * Checks the HTML content for a audio, video, object, embed, or iframe tags.
    48144814 *
    48154815 * @since 3.6.0
    … …  
    50145014
    50155015/**
    5016  * Check a specified post's content for gallery and, if present, return the first
     5016 * Checks a specified post's content for gallery and, if present, return the first
    50175017 *
    50185018 * @since 3.6.0
    … …  
    50395039
    50405040/**
    5041  * Retrieve the image srcs from galleries from a post's content, if present
     5041 * Retrieves the image srcs from galleries from a post's content, if present.
    50425042 *
    50435043 * @since 3.6.0
    … …  
    50555055
    50565056/**
    5057  * Checks a post's content for galleries and return the image srcs for the first found gallery
     5057 * Checks a post's content for galleries and return the image srcs for the first found gallery.
    50585058 *
    50595059 * @since 3.6.0
    … …  
    52545254
    52555255/**
    5256  * Add additional default image sub-sizes.
     5256 * Adds additional default image sub-sizes.
    52575257 *
    52585258 * These sizes are meant to enhance the way WordPress displays images on the front-end on larger,
Note: See TracChangeset for help on using the changeset viewer.