From 8db8a24e46a345d773193044ab130e227e411f84 Mon Sep 17 00:00:00 2001 From: Felix Arntz Date: Wed, 17 May 2023 18:31:24 +0000 Subject: [PATCH] Media: Introduce `wp_get_attachment_image_context` filter. Since WordPress 5.9, a "context" value of "wp_get_attachment_image" has been used in the `wp_get_attachment_image()` function to provide context to underlying functions where that is relevant, e.g. `wp_get_loading_attr_default()`. Since that value used to be not customizable, it required a workaround in `get_the_post_thumbnail()` to avoid calling those functions in `wp_get_attachment_image()`, which resulted in unnecessary complexity and was prone to errors. This changeset introduces a `wp_get_attachment_image_context` filter and leverages it with private filter callback functions that are leveraged by default when `get_the_post_thumbnail()` is called. This avoids the need for the previous workaround and furthermore provides flexibility for other callers of `wp_get_attachment_image()` to provide their own contexts. Props flixos90, costdev, thekt12, westonruter, spacedmonkey. Fixes #58212. Built from https://develop.svn.wordpress.org/trunk@55821 git-svn-id: http://core.svn.wordpress.org/trunk@55333 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/default-filters.php | 4 +- wp-includes/media.php | 54 ++++++++++++++++++++++++- wp-includes/post-thumbnail-template.php | 16 -------- wp-includes/version.php | 2 +- 4 files changed, 56 insertions(+), 20 deletions(-) diff --git a/wp-includes/default-filters.php b/wp-includes/default-filters.php index 6d0f0fee4a..82b579913a 100644 --- a/wp-includes/default-filters.php +++ b/wp-includes/default-filters.php @@ -444,9 +444,11 @@ add_action( 'delete_term', '_wp_delete_tax_menu_item', 10, 3 ); add_action( 'transition_post_status', '_wp_auto_add_pages_to_menu', 10, 3 ); add_action( 'delete_post', '_wp_delete_customize_changeset_dependent_auto_drafts' ); -// Post Thumbnail CSS class filtering. +// Post Thumbnail specific image filtering. add_action( 'begin_fetch_post_thumbnail_html', '_wp_post_thumbnail_class_filter_add' ); add_action( 'end_fetch_post_thumbnail_html', '_wp_post_thumbnail_class_filter_remove' ); +add_action( 'begin_fetch_post_thumbnail_html', '_wp_post_thumbnail_context_filter_add' ); +add_action( 'end_fetch_post_thumbnail_html', '_wp_post_thumbnail_context_filter_remove' ); // Redirect old slugs. add_action( 'template_redirect', 'wp_old_slug_redirect' ); diff --git a/wp-includes/media.php b/wp-includes/media.php index 1478832785..111a99d02f 100644 --- a/wp-includes/media.php +++ b/wp-includes/media.php @@ -1050,9 +1050,18 @@ function wp_get_attachment_image( $attachment_id, $size = 'thumbnail', $icon = f 'decoding' => 'async', ); + /** + * Filters the context in which wp_get_attachment_image() is used. + * + * @since 6.3.0 + * + * @param string $context The context. Default 'wp_get_attachment_image'. + */ + $context = apply_filters( 'wp_get_attachment_image_context', 'wp_get_attachment_image' ); + // Add `loading` attribute. - if ( wp_lazy_loading_enabled( 'img', 'wp_get_attachment_image' ) ) { - $default_attr['loading'] = wp_get_loading_attr_default( 'wp_get_attachment_image' ); + if ( wp_lazy_loading_enabled( 'img', $context ) ) { + $default_attr['loading'] = wp_get_loading_attr_default( $context ); } $attr = wp_parse_args( $attr, $default_attr ); @@ -2170,6 +2179,47 @@ function _wp_post_thumbnail_class_filter_remove( $attr ) { remove_filter( 'wp_get_attachment_image_attributes', '_wp_post_thumbnail_class_filter' ); } +/** + * Overrides the context used in {@see wp_get_attachment_image()}. Internal use only. + * + * Uses the {@see 'begin_fetch_post_thumbnail_html'} and {@see 'end_fetch_post_thumbnail_html'} + * action hooks to dynamically add/remove itself so as to only filter post thumbnails. + * + * @ignore + * @since 6.3.0 + * @access private + * + * @param string $context The context for rendering an attachment image. + * @return string Modified context set to 'the_post_thumbnail'. + */ +function _wp_post_thumbnail_context_filter( $context ) { + return 'the_post_thumbnail'; +} + +/** + * Adds the '_wp_post_thumbnail_context_filter' callback to the 'wp_get_attachment_image_context' + * filter hook. Internal use only. + * + * @ignore + * @since 6.3.0 + * @access private + */ +function _wp_post_thumbnail_context_filter_add() { + add_filter( 'wp_get_attachment_image_context', '_wp_post_thumbnail_context_filter' ); +} + +/** + * Removes the '_wp_post_thumbnail_context_filter' callback from the 'wp_get_attachment_image_context' + * filter hook. Internal use only. + * + * @ignore + * @since 6.3.0 + * @access private + */ +function _wp_post_thumbnail_context_filter_remove() { + remove_filter( 'wp_get_attachment_image_context', '_wp_post_thumbnail_context_filter' ); +} + add_shortcode( 'wp_caption', 'img_caption_shortcode' ); add_shortcode( 'caption', 'img_caption_shortcode' ); diff --git a/wp-includes/post-thumbnail-template.php b/wp-includes/post-thumbnail-template.php index b349cc66e5..e801d53a97 100644 --- a/wp-includes/post-thumbnail-template.php +++ b/wp-includes/post-thumbnail-template.php @@ -186,22 +186,6 @@ function get_the_post_thumbnail( $post = null, $size = 'post-thumbnail', $attr = update_post_thumbnail_cache(); } - // Add `loading` attribute. - if ( wp_lazy_loading_enabled( 'img', 'the_post_thumbnail' ) ) { - // Get the 'loading' attribute value to use as default, taking precedence over the default from - // `wp_get_attachment_image()`. - $loading = wp_get_loading_attr_default( 'the_post_thumbnail' ); - - // Add the default to the given attributes unless they already include a 'loading' directive. - if ( empty( $attr ) ) { - $attr = array( 'loading' => $loading ); - } elseif ( is_array( $attr ) && ! array_key_exists( 'loading', $attr ) ) { - $attr['loading'] = $loading; - } elseif ( is_string( $attr ) && ! preg_match( '/(^|&)loading=/', $attr ) ) { - $attr .= '&loading=' . $loading; - } - } - $html = wp_get_attachment_image( $post_thumbnail_id, $size, false, $attr ); /** diff --git a/wp-includes/version.php b/wp-includes/version.php index 7a20741451..6b6dd885eb 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -16,7 +16,7 @@ * * @global string $wp_version */ -$wp_version = '6.3-alpha-55820'; +$wp_version = '6.3-alpha-55821'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.