Commit c084cd1a authored by Sergey Biryukov's avatar Sergey Biryukov
Browse files

Docs: Add documentation and a `@since` note about the `loading` attribute...

Docs: Add documentation and a `@since` note about the `loading` attribute added to `wp_get_attachment_image()`.

Follow-up to [48272].

Props audrasjb.
Merges [48852] and [48853] to the 5.5 branch.
Fixes #51122.
Built from https://develop.svn.wordpress.org/branches/5.5@48854


git-svn-id: https://core.svn.wordpress.org/branches/5.5@48616 1a063a9b-81f0-0310-95a4-ce76da25c4cd
parent 56c434cd
Loading
Loading
Loading
Loading
+14 −9
Original line number Diff line number Diff line
@@ -1002,6 +1002,8 @@ function wp_get_attachment_image_src( $attachment_id, $size = 'thumbnail', $icon
 * browser scale down the image.
 *
 * @since 2.5.0
 * @since 4.4.0 The `$srcset` and `$sizes` attributes were added.
 * @since 5.5.0 The `$loading` attribute was added.
 *
 * @param int          $attachment_id Image attachment ID.
 * @param string|array $size          Optional. Image size. Accepts any valid image size, or an array of width
@@ -1017,6 +1019,9 @@ function wp_get_attachment_image_src( $attachment_id, $size = 'thumbnail', $icon
 *     @type string       $alt     Image description for the alt attribute.
 *     @type string       $srcset  The 'srcset' attribute value.
 *     @type string       $sizes   The 'sizes' attribute value.
 *     @type string|false $loading The 'loading' attribute value. Passing a value of false
 *                                 will result in the attribute being omitted for the image.
 *                                 Defaults to 'lazy', depending on wp_lazy_loading_enabled().
 * }
 * @return string HTML img element or empty string on failure.
 */
@@ -1048,8 +1053,8 @@ function wp_get_attachment_image( $attachment_id, $size = 'thumbnail', $icon = f

		$attr = wp_parse_args( $attr, $default_attr );

		// If `loading` attribute default of `lazy` is overridden for this
		// image to omit the attribute, ensure it is not included.
		// If the default value of `lazy` for the `loading` attribute is overridden
		// to omit the attribute for this image, ensure it is not included.
		if ( array_key_exists( 'loading', $attr ) && ! $attr['loading'] ) {
			unset( $attr['loading'] );
		}
+1 −1
Original line number Diff line number Diff line
@@ -13,7 +13,7 @@
 *
 * @global string $wp_version
 */
$wp_version = '5.5.1-alpha-48851';
$wp_version = '5.5.1-alpha-48854';

/**
 * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.