Skip to content

Leverage od_start_template_optimization action to initialize common LCP external background image data #1921

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

Draft
wants to merge 1 commit into
base: trunk
Choose a base branch
from
Draft

Leverage od_start_template_optimization action to initialize common LCP external background image data #1921

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
33 changes: 19 additions & 14 deletions plugins/image-prioritizer/class-image-prioritizer-background-image-styled-tag-visitor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,25 @@ final class Image_Prioritizer_Background_Image_Styled_Tag_Visitor extends Image_
* @since 0.3.0
* @var array<array{OD_URL_Metric_Group, LcpElementExternalBackgroundImage}>
*/
private $group_common_lcp_element_external_background_images;
private $group_common_lcp_element_external_background_images = array();

/**
* Gathers the tuples of URL Metric group and the common LCP element external background image.
*
* This is called during the `od_start_template_optimization` action, which is before any tag visitor is first invoked.
*
* @since n.e.x.t
*
* @param OD_Template_Optimization_Context $context Template optimization context.
*/
public function gather_group_common_lcp_element_external_background_images( OD_Template_Optimization_Context $context ): void {
foreach ( $context->url_metric_group_collection as $group ) {
$common = $this->get_common_lcp_element_external_background_image( $group );
if ( is_array( $common ) ) {
$this->group_common_lcp_element_external_background_images[] = array( $group, $common );
}
}
}

/**
* Visits a tag.
Expand Down Expand Up @@ -141,19 +159,6 @@ private function get_common_lcp_element_external_background_image( OD_URL_Metric
* @param OD_Tag_Visitor_Context $context Context.
*/
private function maybe_preload_external_lcp_background_image( OD_Tag_Visitor_Context $context ): void {
// Gather the tuples of URL Metric group and the common LCP element external background image.
// Note the groups of URL Metrics do not change across invocations, we just need to compute this once for all.
// TODO: Instead of populating this here, it could be done once per invocation during the od_start_template_optimization action since the page's OD_URL_Metric_Group_Collection is available there.
if ( ! is_array( $this->group_common_lcp_element_external_background_images ) ) {
$this->group_common_lcp_element_external_background_images = array();
foreach ( $context->url_metric_group_collection as $group ) {
$common = $this->get_common_lcp_element_external_background_image( $group );
if ( is_array( $common ) ) {
$this->group_common_lcp_element_external_background_images[] = array( $group, $common );
}
}
}

// There are no common LCP background images, so abort.
if ( count( $this->group_common_lcp_element_external_background_images ) === 0 ) {
return;
Expand Down
1 change: 1 addition & 0 deletions plugins/image-prioritizer/helper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ function image_prioritizer_register_tag_visitors( OD_Tag_Visitor_Registry $regis
$registry->register( 'image-prioritizer/img', $img_visitor );

$bg_image_visitor = new Image_Prioritizer_Background_Image_Styled_Tag_Visitor();
add_action( 'od_start_template_optimization', array( $bg_image_visitor, 'gather_group_common_lcp_element_external_background_images' ) );
$registry->register( 'image-prioritizer/background-image', $bg_image_visitor );

$video_visitor = new Image_Prioritizer_Video_Tag_Visitor();
Expand Down
Loading