WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs: Improve documentation for the `$attr` parameter of `wp_get_attachment_image()`. 

Props juanfra, Mte90, DrewAPicture, joemcgill, SergeyBiryukov.
Fixes #36661.
Built from https://develop.svn.wordpress.org/trunk@47249


git-svn-id: http://core.svn.wordpress.org/trunk@47049 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2020-02-10 22:03:07 +00:00
parent f8f24b49e6
commit 363191d8ee
2 changed files with 20 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
wp-includes/media.php
View File

@ -363,8 +363,8 @@ function set_post_thumbnail_size( $width = 0, $height = 0, $crop = false ) {
* @since 2.5.0 * @since 2.5.0
* *
* @param int $id Attachment ID. * @param int $id Attachment ID.
* @param string $alt Image Description for the alt attribute. * @param string $alt Image description for the alt attribute.
* @param string $title Image Description for the title attribute. * @param string $title Image description for the title attribute.
* @param string $align Part of the class name for aligning the image. * @param string $align Part of the class name for aligning the image.
* @param string|array $size Optional. Registered image size to retrieve a tag for. Accepts any * @param string|array $size Optional. Registered image size to retrieve a tag for. Accepts any
* valid image size, or an array of width and height values in pixels * valid image size, or an array of width and height values in pixels
@ -402,8 +402,8 @@ function get_image_tag( $id, $alt, $title, $align, $size = 'medium' ) {
* *
* @param string $html HTML content for the image. * @param string $html HTML content for the image.
* @param int $id Attachment ID. * @param int $id Attachment ID.
* @param string $alt Alternate text. * @param string $alt Image description for the alt attribute.
* @param string $title Attachment title. * @param string $title Image description for the title attribute.
* @param string $align Part of the class name for aligning the image. * @param string $align Part of the class name for aligning the image.
* @param string|array $size Size of image. Image size or array of width and height values (in that order). * @param string|array $size Size of image. Image size or array of width and height values (in that order).
* Default 'medium'. * Default 'medium'.
@ -999,14 +999,24 @@ function wp_get_attachment_image_src( $attachment_id, $size = 'thumbnail', $icon
* @param string|array $size Optional. Image size. Accepts any valid image size, or an array of width * @param string|array $size Optional. Image size. Accepts any valid image size, or an array of width
* and height values in pixels (in that order). Default 'thumbnail'. * and height values in pixels (in that order). Default 'thumbnail'.
* @param bool $icon Optional. Whether the image should be treated as an icon. Default false. * @param bool $icon Optional. Whether the image should be treated as an icon. Default false.
* @param string|array $attr Optional. Attributes for the image markup. Default empty. * @param string|array $attr {
* Optional. Attributes for the image markup.
*
* @type string $src Image attachment URL.
* @type string $class CSS class name or space-separated list of classes.
* Default `attachment-$size_class size-$size_class`,
* where `$size_class` is the image size being requested.
* @type string $alt Image description for the alt attribute.
* @type string $srcset The 'srcset' attribute value.
* @type string $sizes The 'sizes' attribute value.
* }
* @return string HTML img element or empty string on failure. * @return string HTML img element or empty string on failure.
*/ */
function wp_get_attachment_image( $attachment_id, $size = 'thumbnail', $icon = false, $attr = '' ) { function wp_get_attachment_image( $attachment_id, $size = 'thumbnail', $icon = false, $attr = '' ) {
$html = ''; $html = '';
$image = wp_get_attachment_image_src( $attachment_id, $size, $icon ); $image = wp_get_attachment_image_src( $attachment_id, $size, $icon );
if ( $image ) { if ( $image ) {
list($src, $width, $height) = $image; list( $src, $width, $height ) = $image;
$hwstring = image_hwstring( $width, $height ); $hwstring = image_hwstring( $width, $height );
$size_class = $size; $size_class = $size;
if ( is_array( $size_class ) ) { if ( is_array( $size_class ) ) {
@ -1046,6 +1056,7 @@ function wp_get_attachment_image( $attachment_id, $size = 'thumbnail', $icon = f
* @since 2.8.0 * @since 2.8.0
* *
* @param string[] $attr Array of attribute values for the image markup, keyed by attribute name. * @param string[] $attr Array of attribute values for the image markup, keyed by attribute name.
* See wp_get_attachment_image().
* @param WP_Post $attachment Image attachment post. * @param WP_Post $attachment Image attachment post.
* @param string|array $size Requested size. Image size or array of width and height values * @param string|array $size Requested size. Image size or array of width and height values
* (in that order). Default 'thumbnail'. * (in that order). Default 'thumbnail'.

2
wp-includes/version.php
View File

@ -13,7 +13,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.4-alpha-47248'; $wp_version = '5.4-alpha-47249';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.