Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Accurate sizes: Use block context approach #1625

Open
wants to merge 13 commits into
base: feature/1511-incorporate-layout-constraints-from-ancestors
Choose a base branch
from
+109 −59
Open

Accurate sizes: Use block context approach #1625

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
3d61681
Update existing code with new approach
mukeshpanchal27 Oct 22, 2024
4396c78
Fix spell
mukeshpanchal27 Oct 23, 2024
8edeb67
Merge branch 'feature/1511-incorporate-layout-constraints-from-ancest…
mukeshpanchal27 Oct 23, 2024
af890e2
Disable lazy loading attribute for unit tests
mukeshpanchal27 Oct 23, 2024
d9af569
Fix comment indention
mukeshpanchal27 Oct 24, 2024
b87adcf
Use HTML API for attachment cache
mukeshpanchal27 Oct 24, 2024
bfdab10
Address review feedback
mukeshpanchal27 Oct 25, 2024
97dcb8f
Apply suggestions from code review
mukeshpanchal27 Oct 28, 2024
2cbf39d
Add types for function variables
mukeshpanchal27 Oct 28, 2024
4c7faa0
Fix lint PHP
mukeshpanchal27 Oct 28, 2024
dd0e12b
Apply suggestions from code review
mukeshpanchal27 Nov 6, 2024
fad4e87
Remove unused parameter from auto_sizes_prime_attachment_caches()
mukeshpanchal27 Nov 6, 2024
198f2cd
Fix PHPStan error
mukeshpanchal27 Nov 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
162 changes: 105 additions & 57 deletions plugins/auto-sizes/hooks.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,79 +139,139 @@ function auto_sizes_get_width( string $layout_width, int $image_width ): string
}

/**
* Filter the sizes attribute for images to improve the default calculation.
* Primes attachment into the cache with a single database query.
*
* @since 1.1.0
* @since n.e.x.t
*
* @param string $content The block content about to be rendered.
* @param array{ attrs?: array{ align?: string, width?: string } } $parsed_block The parsed block.
* @return string The updated block content.
* @param string $content The HTML content.
* @param string $context Optional. Additional context to pass to the filters.
* Defaults to `current_filter()` when not set.
mukeshpanchal27 marked this conversation as resolved.
Show resolved Hide resolved
* @return string The HTML content.
*/
function auto_sizes_filter_image_tag( string $content, array $parsed_block ): string {
function auto_sizes_prime_attachment_caches( string $content, string $context = null ): string {
if ( null === $context ) {
mukeshpanchal27 marked this conversation as resolved.
Show resolved Hide resolved
$context = current_filter();
}
mukeshpanchal27 marked this conversation as resolved.
Show resolved Hide resolved

$processor = new WP_HTML_Tag_Processor( $content );
$has_image = $processor->next_tag( array( 'tag_name' => 'img' ) );

// Only update the markup if an image is found.
if ( $has_image ) {
$processor->set_attribute( 'data-needs-sizes-update', true );
if ( isset( $parsed_block['attrs']['align'] ) ) {
$processor->set_attribute( 'data-align', $parsed_block['attrs']['align'] );
$images = array();
while ( $processor->next_tag( array( 'tag_name' => 'IMG' ) ) ) {
$class = $processor->get_attribute( 'class' );

if ( ! is_string( $class ) ) {
continue;
}

// Resize image width.
if ( isset( $parsed_block['attrs']['width'] ) ) {
$processor->set_attribute( 'data-resize-width', $parsed_block['attrs']['width'] );
if ( preg_match( '/wp-image-([0-9]+)/i', $class, $class_id ) === 1 ) {
mukeshpanchal27 marked this conversation as resolved.
Show resolved Hide resolved
$attachment_id = absint( $class_id[1] );
mukeshpanchal27 marked this conversation as resolved.
Show resolved Hide resolved
if ( $attachment_id > 0 ) {
$images[] = $attachment_id;
}
}
}

// Reduce the array to unique attachment IDs.
$attachment_ids = array_unique( array_filter( $images ) );

$content = $processor->get_updated_html();
if ( count( $attachment_ids ) > 1 ) {
/*
* Warm the object cache with post and meta information for all found
* images to avoid making individual database calls.
*/
_prime_post_caches( $attachment_ids, false, true );
}

return $content;
}
add_filter( 'render_block_core/image', 'auto_sizes_filter_image_tag', 10, 2 );
add_filter( 'render_block_core/cover', 'auto_sizes_filter_image_tag', 10, 2 );
add_filter( 'the_content', 'auto_sizes_prime_attachment_caches', 6 );

/**
* Filter the sizes attribute for images to improve the default calculation.
*
* @since 1.1.0
*
* @param string $content The block content about to be rendered.
* @param string $content The block content about to be rendered.
mukeshpanchal27 marked this conversation as resolved.
Show resolved Hide resolved
* @param array{ attrs?: array{ align?: string, width?: string } } $parsed_block The parsed block.
* @param WP_Block $block Block instance.
* @return string The updated block content.
*/
function auto_sizes_improve_image_sizes_attributes( string $content ): string {
function auto_sizes_filter_image_tag( string $content, array $parsed_block, WP_Block $block ): string {
mukeshpanchal27 marked this conversation as resolved.
Show resolved Hide resolved
$processor = new WP_HTML_Tag_Processor( $content );
if ( ! $processor->next_tag( array( 'tag_name' => 'img' ) ) ) {
return $content;
}
$has_image = $processor->next_tag( array( 'tag_name' => 'IMG' ) );

$remove_data_attributes = static function () use ( $processor ): void {
$processor->remove_attribute( 'data-needs-sizes-update' );
$processor->remove_attribute( 'data-align' );
$processor->remove_attribute( 'data-resize-width' );
};
// Only update the markup if an image is found.
if ( $has_image ) {

/**
* Callback for calculating image sizes attribute value for an image block.
*
* This is a workaround to use block context data when calculating the img sizes attribute.
*
* @param string $sizes The image sizes attribute value.
* @param string $size The image size data.
*/
$filter = static function ( $sizes, $size ) use ( $block ) {
$id = $block->attributes['id'] ?? 0;
$alignment = $block->attributes['align'] ?? '';
$width = $block->attributes['width'] ?? '';

// Hypothetical function to calculate better sizes.
$sizes = auto_sizes_calculate_better_sizes( $id, $size, $alignment, $width );
mukeshpanchal27 marked this conversation as resolved.
Show resolved Hide resolved

return $sizes;
};

// Hook this filter early, before default filters are run.
add_filter( 'wp_calculate_image_sizes', $filter, 9, 2 );

$sizes = wp_calculate_image_sizes(
// If we don't have a size slug, assume the full size was used.
$parsed_block['attrs']['sizeSlug'] ?? 'full',
null,
null,
$parsed_block['attrs']['id'] ?? 0
);

remove_filter( 'wp_calculate_image_sizes', $filter, 9 );

// Bail early if sizes are not calculated.
if ( false === $sizes ) {
return $content;
}

$processor->set_attribute( 'sizes', $sizes );

// Bail early if the responsive images are disabled.
if ( null === $processor->get_attribute( 'sizes' ) ) {
$remove_data_attributes();
return $processor->get_updated_html();
}

// Skips second time parsing if already processed.
if ( null === $processor->get_attribute( 'data-needs-sizes-update' ) ) {
return $content;
}
return $content;
}
add_filter( 'render_block_core/image', 'auto_sizes_filter_image_tag', 10, 3 );
add_filter( 'render_block_core/cover', 'auto_sizes_filter_image_tag', 10, 3 );

/**
* Hypothetical function to calculate better sizes.
*
* @param int $id The image id.
* @param string $size The image size data.
* @param string $align The image alignment.
* @param string $resize_width Resize image width.
* @return string The sizes attribute value.
*/
function auto_sizes_calculate_better_sizes( int $id, string $size, string $align, string $resize_width ): string {
$sizes = '';
$image = wp_get_attachment_image_src( $id, $size );

$align = $processor->get_attribute( 'data-align' );
if ( false === $image ) {
return $sizes;
}

// Retrieve width from the image tag itself.
$image_width = $processor->get_attribute( 'width' );
if ( ! is_string( $image_width ) && ! in_array( $align, array( 'full', 'wide' ), true ) ) {
return $content;
}
$image_width = '' !== $resize_width ? (int) $resize_width : $image[1];

$layout = wp_get_global_settings( array( 'layout' ) );

$sizes = null;
// Handle different alignment use cases.
switch ( $align ) {
case 'full':
Expand All @@ -227,28 +287,16 @@ function auto_sizes_improve_image_sizes_attributes( string $content ): string {
case 'left':
case 'right':
case 'center':
// Resize image width.
$image_width = $processor->get_attribute( 'data-resize-width' ) ?? $image_width;
$sizes = sprintf( '(max-width: %1$dpx) 100vw, %1$dpx', $image_width );
$sizes = sprintf( '(max-width: %1$dpx) 100vw, %1$dpx', $image_width );
break;

default:
if ( array_key_exists( 'contentSize', $layout ) ) {
// Resize image width.
$image_width = $processor->get_attribute( 'data-resize-width' ) ?? $image_width;
$width = auto_sizes_get_width( $layout['contentSize'], (int) $image_width );
$sizes = sprintf( '(max-width: %1$s) 100vw, %1$s', $width );
$width = auto_sizes_get_width( $layout['contentSize'], $image_width );
$sizes = sprintf( '(max-width: %1$s) 100vw, %1$s', $width );
}
break;
}

if ( is_string( $sizes ) ) {
$processor->set_attribute( 'sizes', $sizes );
}

$remove_data_attributes();

return $processor->get_updated_html();
return $sizes;
}
// Run filter prior to auto sizes "auto_sizes_update_content_img_tag" filter.
add_filter( 'wp_content_img_tag', 'auto_sizes_improve_image_sizes_attributes', 9 );
5 changes: 3 additions & 2 deletions plugins/auto-sizes/tests/test-improve-sizes.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,13 @@ public function set_up(): void {

// Disable auto sizes.
remove_filter( 'wp_content_img_tag', 'auto_sizes_update_content_img_tag' );

// Disable lazy loading attribute.
add_filter( 'wp_img_tag_add_loading_attr', '__return_false' );
}

/**
* Test that if disable responsive image then it will not add sizes attribute.
*
* @covers ::auto_sizes_improve_image_sizes_attributes
*/
public function test_that_if_disable_responsive_image_then_it_will_not_add_sizes_attribute(): void {
// Disable responsive images.
Expand Down
Loading