Docs: Use third-person singular verbs in Media API function descriptions, as per docblocks standards.
See #55646. Built from https://develop.svn.wordpress.org/trunk@54173 git-svn-id: http://core.svn.wordpress.org/trunk@53732 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
audrasjb
parent
83a2c2428a
commit
81ada51ba4
|
|
@ -7,7 +7,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* Retrieve additional image sizes.
|
||||
* Retrieves additional image sizes.
|
||||
*
|
||||
* @since 4.7.0
|
||||
*
|
||||
|
|
@ -26,7 +26,7 @@ function wp_get_additional_image_sizes() {
|
|||
}
|
||||
|
||||
/**
|
||||
* Scale down the default size of an image.
|
||||
* Scales down the default size of an image.
|
||||
*
|
||||
* This is so that the image is a better fit for the editor and theme.
|
||||
*
|
||||
|
|
@ -136,7 +136,7 @@ function image_constrain_size_for_editor( $width, $height, $size = 'medium', $co
|
|||
}
|
||||
|
||||
/**
|
||||
* Retrieve width and height attributes using given width and height values.
|
||||
* Retrieves width and height attributes using given width and height values.
|
||||
*
|
||||
* Both attributes are required in the sense that both parameters must have a
|
||||
* value, but are optional in that if you set them to false or null, then they
|
||||
|
|
@ -164,7 +164,7 @@ function image_hwstring( $width, $height ) {
|
|||
}
|
||||
|
||||
/**
|
||||
* Scale an image to fit a particular size (such as 'thumb' or 'medium').
|
||||
* Scales an image to fit a particular size (such as 'thumb' or 'medium').
|
||||
*
|
||||
* The URL might be the original image, or it might be a resized version. This
|
||||
* function won't create a new resized copy, it will just return an already
|
||||
|
|
@ -272,7 +272,7 @@ function image_downsize( $id, $size = 'medium' ) {
|
|||
}
|
||||
|
||||
/**
|
||||
* Register a new image size.
|
||||
* Registers a new image size.
|
||||
*
|
||||
* @since 2.9.0
|
||||
*
|
||||
|
|
@ -299,7 +299,7 @@ function add_image_size( $name, $width = 0, $height = 0, $crop = false ) {
|
|||
}
|
||||
|
||||
/**
|
||||
* Check if an image size exists.
|
||||
* Checks if an image size exists.
|
||||
*
|
||||
* @since 3.9.0
|
||||
*
|
||||
|
|
@ -312,7 +312,7 @@ function has_image_size( $name ) {
|
|||
}
|
||||
|
||||
/**
|
||||
* Remove a new image size.
|
||||
* Removes a new image size.
|
||||
*
|
||||
* @since 3.9.0
|
||||
*
|
||||
|
|
@ -368,7 +368,7 @@ function set_post_thumbnail_size( $width = 0, $height = 0, $crop = false ) {
|
|||
* @param string $align Part of the class name for aligning the image.
|
||||
* @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array of
|
||||
* width and height values in pixels (in that order). Default 'medium'.
|
||||
* @return string HTML IMG element for given image attachment
|
||||
* @return string HTML IMG element for given image attachment?
|
||||
*/
|
||||
function get_image_tag( $id, $alt, $title, $align, $size = 'medium' ) {
|
||||
|
||||
|
|
@ -993,7 +993,7 @@ function wp_get_attachment_image_src( $attachment_id, $size = 'thumbnail', $icon
|
|||
}
|
||||
|
||||
/**
|
||||
* Get an HTML img element representing an image attachment.
|
||||
* Gets an HTML img element representing an image attachment.
|
||||
*
|
||||
* While `$size` will accept an array, it is better to register a size with
|
||||
* add_image_size() so that a cropped version is generated. It's much more
|
||||
|
|
@ -1105,7 +1105,7 @@ function wp_get_attachment_image( $attachment_id, $size = 'thumbnail', $icon = f
|
|||
}
|
||||
|
||||
/**
|
||||
* HTML img element representing an image attachment.
|
||||
* Filters the HTML img element representing an image attachment.
|
||||
*
|
||||
* @since 5.6.0
|
||||
*
|
||||
|
|
@ -1121,7 +1121,7 @@ function wp_get_attachment_image( $attachment_id, $size = 'thumbnail', $icon = f
|
|||
}
|
||||
|
||||
/**
|
||||
* Get the URL of an image attachment.
|
||||
* Gets the URL of an image attachment.
|
||||
*
|
||||
* @since 4.4.0
|
||||
*
|
||||
|
|
@ -1138,7 +1138,7 @@ function wp_get_attachment_image_url( $attachment_id, $size = 'thumbnail', $icon
|
|||
}
|
||||
|
||||
/**
|
||||
* Get the attachment path relative to the upload directory.
|
||||
* Gets the attachment path relative to the upload directory.
|
||||
*
|
||||
* @since 4.4.1
|
||||
* @access private
|
||||
|
|
@ -1163,7 +1163,7 @@ function _wp_get_attachment_relative_path( $file ) {
|
|||
}
|
||||
|
||||
/**
|
||||
* Get the image size as array from its meta data.
|
||||
* Gets the image size as array from its meta data.
|
||||
*
|
||||
* Used for responsive images.
|
||||
*
|
||||
|
|
@ -1247,7 +1247,7 @@ function wp_get_attachment_image_srcset( $attachment_id, $size = 'medium', $imag
|
|||
*/
|
||||
function wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attachment_id = 0 ) {
|
||||
/**
|
||||
* Let plugins pre-filter the image meta to be able to fix inconsistencies in the stored data.
|
||||
* Pre-filters the image meta to be able to fix inconsistencies in the stored data.
|
||||
*
|
||||
* @since 4.5.0
|
||||
*
|
||||
|
|
@ -2662,7 +2662,7 @@ function wp_underscore_playlist_templates() {
|
|||
}
|
||||
|
||||
/**
|
||||
* Outputs and enqueue default scripts and styles for playlists.
|
||||
* Outputs and enqueues default scripts and styles for playlists.
|
||||
*
|
||||
* @since 3.9.0
|
||||
*
|
||||
|
|
@ -3750,7 +3750,7 @@ function is_gd_image( $image ) {
|
|||
}
|
||||
|
||||
/**
|
||||
* Create new GD image resource with transparency support
|
||||
* Creates new GD image resource with transparency support.
|
||||
*
|
||||
* @todo Deprecate if possible.
|
||||
*
|
||||
|
|
@ -3775,7 +3775,7 @@ function wp_imagecreatetruecolor( $width, $height ) {
|
|||
}
|
||||
|
||||
/**
|
||||
* Based on a supplied width/height example, return the biggest possible dimensions based on the max width/height.
|
||||
* Based on a supplied width/height example, returns the biggest possible dimensions based on the max width/height.
|
||||
*
|
||||
* @since 2.9.0
|
||||
*
|
||||
|
|
@ -4810,7 +4810,7 @@ function get_attached_media( $type, $post = 0 ) {
|
|||
}
|
||||
|
||||
/**
|
||||
* Check the content HTML for a audio, video, object, embed, or iframe tags.
|
||||
* Checks the HTML content for a audio, video, object, embed, or iframe tags.
|
||||
*
|
||||
* @since 3.6.0
|
||||
*
|
||||
|
|
@ -5013,7 +5013,7 @@ function get_post_galleries( $post, $html = true ) {
|
|||
}
|
||||
|
||||
/**
|
||||
* Check a specified post's content for gallery and, if present, return the first
|
||||
* Checks a specified post's content for gallery and, if present, return the first
|
||||
*
|
||||
* @since 3.6.0
|
||||
*
|
||||
|
|
@ -5038,7 +5038,7 @@ function get_post_gallery( $post = 0, $html = true ) {
|
|||
}
|
||||
|
||||
/**
|
||||
* Retrieve the image srcs from galleries from a post's content, if present
|
||||
* Retrieves the image srcs from galleries from a post's content, if present.
|
||||
*
|
||||
* @since 3.6.0
|
||||
*
|
||||
|
|
@ -5054,7 +5054,7 @@ function get_post_galleries_images( $post = 0 ) {
|
|||
}
|
||||
|
||||
/**
|
||||
* Checks a post's content for galleries and return the image srcs for the first found gallery
|
||||
* Checks a post's content for galleries and return the image srcs for the first found gallery.
|
||||
*
|
||||
* @since 3.6.0
|
||||
*
|
||||
|
|
@ -5253,7 +5253,7 @@ function wp_media_personal_data_exporter( $email_address, $page = 1 ) {
|
|||
}
|
||||
|
||||
/**
|
||||
* Add additional default image sub-sizes.
|
||||
* Adds additional default image sub-sizes.
|
||||
*
|
||||
* These sizes are meant to enhance the way WordPress displays images on the front-end on larger,
|
||||
* high-density devices. They make it possible to generate more suitable `srcset` and `sizes` attributes
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@
|
|||
*
|
||||
* @global string $wp_version
|
||||
*/
|
||||
$wp_version = '6.1-alpha-54172';
|
||||
$wp_version = '6.1-alpha-54173';
|
||||
|
||||
/**
|
||||
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
||||
|
|
|
|||
Loading…
Reference in New Issue