Edit File by line
/home/zeestwma/ceyloniy.../wp-conte.../plugins/elemento.../modules/image-lo...
File: module.php
<?php
[0] Fix | Delete
namespace Elementor\Modules\ImageLoadingOptimization;
[1] Fix | Delete
[2] Fix | Delete
use Elementor\Core\Base\Module as BaseModule;
[3] Fix | Delete
[4] Fix | Delete
if ( ! defined( 'ABSPATH' ) ) {
[5] Fix | Delete
exit; // Exit if accessed directly.
[6] Fix | Delete
}
[7] Fix | Delete
[8] Fix | Delete
class Module extends BaseModule {
[9] Fix | Delete
/**
[10] Fix | Delete
* @var int Minimum square-pixels threshold.
[11] Fix | Delete
*/
[12] Fix | Delete
private $min_priority_img_pixels = 50000;
[13] Fix | Delete
[14] Fix | Delete
/**
[15] Fix | Delete
* @var int The number of content media elements to not lazy-load.
[16] Fix | Delete
*/
[17] Fix | Delete
private $omit_threshold = 3;
[18] Fix | Delete
[19] Fix | Delete
/**
[20] Fix | Delete
* @var array Keep a track of images for which loading optimization strategy were computed.
[21] Fix | Delete
*/
[22] Fix | Delete
private static $image_visited = [];
[23] Fix | Delete
[24] Fix | Delete
/**
[25] Fix | Delete
* Get Module name.
[26] Fix | Delete
*/
[27] Fix | Delete
public function get_name() {
[28] Fix | Delete
return 'image-loading-optimization';
[29] Fix | Delete
}
[30] Fix | Delete
[31] Fix | Delete
/**
[32] Fix | Delete
* Constructor.
[33] Fix | Delete
*/
[34] Fix | Delete
public function __construct() {
[35] Fix | Delete
if ( ! static::is_optimized_image_loading_enabled() ) {
[36] Fix | Delete
return;
[37] Fix | Delete
}
[38] Fix | Delete
[39] Fix | Delete
parent::__construct();
[40] Fix | Delete
[41] Fix | Delete
// Stop wp core logic.
[42] Fix | Delete
add_action( 'init', [ $this, 'stop_core_fetchpriority_high_logic' ] );
[43] Fix | Delete
add_filter( 'wp_lazy_loading_enabled', '__return_false' );
[44] Fix | Delete
[45] Fix | Delete
// Run optimization logic on header.
[46] Fix | Delete
add_action( 'get_header', [ $this, 'set_buffer' ] );
[47] Fix | Delete
[48] Fix | Delete
// Ensure buffer is flushed (if any) before the content logic.
[49] Fix | Delete
add_filter( 'the_content', [ $this, 'flush_header_buffer' ], 0 );
[50] Fix | Delete
[51] Fix | Delete
// Run optimization logic on content.
[52] Fix | Delete
add_filter( 'wp_content_img_tag', [ $this, 'loading_optimization_image' ] );
[53] Fix | Delete
}
[54] Fix | Delete
[55] Fix | Delete
/**
[56] Fix | Delete
* Check whether the "Optimized Image Loading" settings is enabled.
[57] Fix | Delete
*
[58] Fix | Delete
* The 'optimized_image_loading' option can be enabled/disabled from the Elementor settings.
[59] Fix | Delete
*
[60] Fix | Delete
* @since 3.21.0
[61] Fix | Delete
* @access private
[62] Fix | Delete
*/
[63] Fix | Delete
private static function is_optimized_image_loading_enabled(): bool {
[64] Fix | Delete
return '1' === get_option( 'elementor_optimized_image_loading', '1' );
[65] Fix | Delete
}
[66] Fix | Delete
[67] Fix | Delete
/**
[68] Fix | Delete
* Stop WordPress core fetchpriority logic by setting the wp_high_priority_element_flag flag to false.
[69] Fix | Delete
*/
[70] Fix | Delete
public function stop_core_fetchpriority_high_logic() {
[71] Fix | Delete
wp_high_priority_element_flag( false );
[72] Fix | Delete
}
[73] Fix | Delete
[74] Fix | Delete
/**
[75] Fix | Delete
* Set buffer to handle header and footer content.
[76] Fix | Delete
*/
[77] Fix | Delete
public function set_buffer() {
[78] Fix | Delete
ob_start( [ $this, 'handle_buffer_content' ] );
[79] Fix | Delete
}
[80] Fix | Delete
[81] Fix | Delete
/**
[82] Fix | Delete
* This function ensure that buffer if any is flushed before the content is called.
[83] Fix | Delete
* This function behaves more like an action than a filter.
[84] Fix | Delete
*
[85] Fix | Delete
* @param string $content the content.
[86] Fix | Delete
* @return string We simply return the content from parameter.
[87] Fix | Delete
*/
[88] Fix | Delete
public function flush_header_buffer( $content ) {
[89] Fix | Delete
$buffer_status = ob_get_status();
[90] Fix | Delete
[91] Fix | Delete
if ( ! empty( $buffer_status ) &&
[92] Fix | Delete
1 === $buffer_status['type'] &&
[93] Fix | Delete
get_class( $this ) . '::handle_buffer_content' === $buffer_status['name'] ) {
[94] Fix | Delete
ob_end_flush();
[95] Fix | Delete
}
[96] Fix | Delete
[97] Fix | Delete
return $content;
[98] Fix | Delete
}
[99] Fix | Delete
[100] Fix | Delete
/**
[101] Fix | Delete
* Callback to handle image optimization logic on buffered content.
[102] Fix | Delete
*
[103] Fix | Delete
* @param string $buffer Buffered content.
[104] Fix | Delete
* @return string Content with optimized images.
[105] Fix | Delete
*/
[106] Fix | Delete
public function handle_buffer_content( $buffer ) {
[107] Fix | Delete
return $this->filter_images( $buffer );
[108] Fix | Delete
}
[109] Fix | Delete
[110] Fix | Delete
/**
[111] Fix | Delete
* Check for image in the content provided and apply optimization logic on them.
[112] Fix | Delete
*
[113] Fix | Delete
* @param string $content Content to be analyzed.
[114] Fix | Delete
* @return string Content with optimized images.
[115] Fix | Delete
*/
[116] Fix | Delete
private function filter_images( $content ) {
[117] Fix | Delete
return preg_replace_callback(
[118] Fix | Delete
'/<img\s[^>]+>/',
[119] Fix | Delete
function ( $matches ) {
[120] Fix | Delete
return $this->loading_optimization_image( $matches[0] );
[121] Fix | Delete
},
[122] Fix | Delete
$content
[123] Fix | Delete
);
[124] Fix | Delete
}
[125] Fix | Delete
[126] Fix | Delete
/**
[127] Fix | Delete
* Apply loading optimization logic on the image.
[128] Fix | Delete
*
[129] Fix | Delete
* @param mixed $image Original image tag.
[130] Fix | Delete
* @return string Optimized image.
[131] Fix | Delete
*/
[132] Fix | Delete
public function loading_optimization_image( $image ) {
[133] Fix | Delete
if ( isset( self::$image_visited[ $image ] ) ) {
[134] Fix | Delete
return self::$image_visited[ $image ];
[135] Fix | Delete
}
[136] Fix | Delete
[137] Fix | Delete
$optimized_image = $this->add_loading_optimization_attrs( $image );
[138] Fix | Delete
self::$image_visited[ $image ] = $optimized_image;
[139] Fix | Delete
[140] Fix | Delete
return $optimized_image;
[141] Fix | Delete
}
[142] Fix | Delete
[143] Fix | Delete
/**
[144] Fix | Delete
* Adds optimization attributes to an `img` HTML tag.
[145] Fix | Delete
*
[146] Fix | Delete
* @param string $image The HTML `img` tag where the attribute should be added.
[147] Fix | Delete
* @return string Converted `img` tag with optimization attributes added.
[148] Fix | Delete
*/
[149] Fix | Delete
private function add_loading_optimization_attrs( $image ) {
[150] Fix | Delete
$width = preg_match( '/ width=["\']([0-9]+)["\']/', $image, $match_width ) ? (int) $match_width[1] : null;
[151] Fix | Delete
$height = preg_match( '/ height=["\']([0-9]+)["\']/', $image, $match_height ) ? (int) $match_height[1] : null;
[152] Fix | Delete
$loading_val = preg_match( '/ loading=["\']([A-Za-z]+)["\']/', $image, $match_loading ) ? $match_loading[1] : null;
[153] Fix | Delete
$fetchpriority_val = preg_match( '/ fetchpriority=["\']([A-Za-z]+)["\']/', $image, $match_fetchpriority ) ? $match_fetchpriority[1] : null;
[154] Fix | Delete
[155] Fix | Delete
// Images should have height and dimension width for the loading optimization attributes to be added.
[156] Fix | Delete
if ( ! str_contains( $image, ' width="' ) || ! str_contains( $image, ' height="' ) ) {
[157] Fix | Delete
return $image;
[158] Fix | Delete
}
[159] Fix | Delete
[160] Fix | Delete
$optimization_attrs = $this->get_loading_optimization_attributes(
[161] Fix | Delete
[
[162] Fix | Delete
'width' => $width,
[163] Fix | Delete
'height' => $height,
[164] Fix | Delete
'loading' => $loading_val,
[165] Fix | Delete
'fetchpriority' => $fetchpriority_val,
[166] Fix | Delete
]
[167] Fix | Delete
);
[168] Fix | Delete
[169] Fix | Delete
if ( ! empty( $optimization_attrs['fetchpriority'] ) ) {
[170] Fix | Delete
$image = str_replace( '<img', '<img fetchpriority="' . esc_attr( $optimization_attrs['fetchpriority'] ) . '"', $image );
[171] Fix | Delete
}
[172] Fix | Delete
[173] Fix | Delete
if ( ! empty( $optimization_attrs['loading'] ) ) {
[174] Fix | Delete
$image = str_replace( '<img', '<img loading="' . esc_attr( $optimization_attrs['loading'] ) . '"', $image );
[175] Fix | Delete
}
[176] Fix | Delete
[177] Fix | Delete
return $image;
[178] Fix | Delete
}
[179] Fix | Delete
[180] Fix | Delete
/**
[181] Fix | Delete
* Return loading Loading optimization attributes for a image with give attribute.
[182] Fix | Delete
*
[183] Fix | Delete
* @param array $attr Existing image attributes.
[184] Fix | Delete
* @return array Loading optimization attributes.
[185] Fix | Delete
*/
[186] Fix | Delete
private function get_loading_optimization_attributes( $attr ) {
[187] Fix | Delete
$loading_attrs = [];
[188] Fix | Delete
[189] Fix | Delete
// For any resources, width and height must be provided, to avoid layout shifts.
[190] Fix | Delete
if ( ! isset( $attr['width'], $attr['height'] ) ) {
[191] Fix | Delete
return $loading_attrs;
[192] Fix | Delete
}
[193] Fix | Delete
[194] Fix | Delete
/*
[195] Fix | Delete
* The key function logic starts here.
[196] Fix | Delete
*/
[197] Fix | Delete
$maybe_in_viewport = null;
[198] Fix | Delete
$increase_count = false;
[199] Fix | Delete
$maybe_increase_count = false;
[200] Fix | Delete
[201] Fix | Delete
/*
[202] Fix | Delete
* Logic to handle a `loading` attribute that is already provided.
[203] Fix | Delete
*
[204] Fix | Delete
* Copied from `wp_get_loading_optimization_attributes()`.
[205] Fix | Delete
*/
[206] Fix | Delete
if ( isset( $attr['loading'] ) ) {
[207] Fix | Delete
/*
[208] Fix | Delete
* Interpret "lazy" as not in viewport. Any other value can be
[209] Fix | Delete
* interpreted as in viewport (realistically only "eager" or `false`
[210] Fix | Delete
* to force-omit the attribute are other potential values).
[211] Fix | Delete
*/
[212] Fix | Delete
if ( 'lazy' === $attr['loading'] ) {
[213] Fix | Delete
$maybe_in_viewport = false;
[214] Fix | Delete
} else {
[215] Fix | Delete
$maybe_in_viewport = true;
[216] Fix | Delete
}
[217] Fix | Delete
}
[218] Fix | Delete
[219] Fix | Delete
// Logic to handle a `fetchpriority` attribute that is already provided.
[220] Fix | Delete
$has_fetchpriority_high_attr = ( isset( $attr['fetchpriority'] ) && 'high' === $attr['fetchpriority'] );
[221] Fix | Delete
[222] Fix | Delete
/*
[223] Fix | Delete
* Handle cases where a `fetchpriority="high"` has already been set.
[224] Fix | Delete
*
[225] Fix | Delete
* Copied from `wp_get_loading_optimization_attributes()`.
[226] Fix | Delete
*/
[227] Fix | Delete
if ( $has_fetchpriority_high_attr ) {
[228] Fix | Delete
/*
[229] Fix | Delete
* If the image was already determined to not be in the viewport (e.g.
[230] Fix | Delete
* from an already provided `loading` attribute), trigger a warning.
[231] Fix | Delete
* Otherwise, the value can be interpreted as in viewport, since only
[232] Fix | Delete
* the most important in-viewport image should have `fetchpriority` set
[233] Fix | Delete
* to "high".
[234] Fix | Delete
*/
[235] Fix | Delete
if ( false === $maybe_in_viewport ) {
[236] Fix | Delete
_doing_it_wrong(
[237] Fix | Delete
__FUNCTION__,
[238] Fix | Delete
esc_html__( 'An image should not be lazy-loaded and marked as high priority at the same time.', 'elementor' ),
[239] Fix | Delete
''
[240] Fix | Delete
);
[241] Fix | Delete
[242] Fix | Delete
/*
[243] Fix | Delete
* Set `fetchpriority` here for backward-compatibility as we should
[244] Fix | Delete
* not override what a developer decided, even though it seems
[245] Fix | Delete
* incorrect.
[246] Fix | Delete
*/
[247] Fix | Delete
$loading_attrs['fetchpriority'] = 'high';
[248] Fix | Delete
} else {
[249] Fix | Delete
$maybe_in_viewport = true;
[250] Fix | Delete
}
[251] Fix | Delete
}
[252] Fix | Delete
[253] Fix | Delete
if ( null === $maybe_in_viewport && ! is_admin() ) {
[254] Fix | Delete
$content_media_count = $this->increase_content_media_count( 0 );
[255] Fix | Delete
$increase_count = true;
[256] Fix | Delete
if ( $content_media_count < $this->omit_threshold ) {
[257] Fix | Delete
$maybe_in_viewport = true;
[258] Fix | Delete
} else {
[259] Fix | Delete
$maybe_in_viewport = false;
[260] Fix | Delete
}
[261] Fix | Delete
}
[262] Fix | Delete
[263] Fix | Delete
if ( $maybe_in_viewport ) {
[264] Fix | Delete
$loading_attrs = $this->maybe_add_fetchpriority_high_attr( $loading_attrs, $attr );
[265] Fix | Delete
} else {
[266] Fix | Delete
$loading_attrs['loading'] = 'lazy';
[267] Fix | Delete
}
[268] Fix | Delete
[269] Fix | Delete
if ( $increase_count ) {
[270] Fix | Delete
$this->increase_content_media_count();
[271] Fix | Delete
} elseif ( $maybe_increase_count ) {
[272] Fix | Delete
if ( $this->get_min_priority_img_pixels() <= $attr['width'] * $attr['height'] ) {
[273] Fix | Delete
$this->increase_content_media_count();
[274] Fix | Delete
}
[275] Fix | Delete
}
[276] Fix | Delete
[277] Fix | Delete
return $loading_attrs;
[278] Fix | Delete
}
[279] Fix | Delete
[280] Fix | Delete
/**
[281] Fix | Delete
* Helper to get the minimum threshold for number of pixels an image needs to have to be considered "priority".
[282] Fix | Delete
*
[283] Fix | Delete
* @return int The minimum number of pixels (width * height). Default is 50000.
[284] Fix | Delete
*/
[285] Fix | Delete
private function get_min_priority_img_pixels() {
[286] Fix | Delete
/**
[287] Fix | Delete
* Filter the minimum pixel threshold used to determine if an image should have fetchpriority="high" applied.
[288] Fix | Delete
*
[289] Fix | Delete
* @see https://developer.wordpress.org/reference/hooks/wp_min_priority_img_pixels/
[290] Fix | Delete
*
[291] Fix | Delete
* @param int $pixels The minimum number of pixels (with * height).
[292] Fix | Delete
* @return int The filtered value.
[293] Fix | Delete
*/
[294] Fix | Delete
return apply_filters( 'elementor/image-loading-optimization/min_priority_img_pixels', $this->min_priority_img_pixels );
[295] Fix | Delete
}
[296] Fix | Delete
[297] Fix | Delete
/**
[298] Fix | Delete
* Keeps a count of media image.
[299] Fix | Delete
*
[300] Fix | Delete
* @param int $amount Amount by which count must be increased.
[301] Fix | Delete
* @return int current image count.
[302] Fix | Delete
*/
[303] Fix | Delete
private function increase_content_media_count( $amount = 1 ) {
[304] Fix | Delete
static $content_media_count = 0;
[305] Fix | Delete
[306] Fix | Delete
$content_media_count += $amount;
[307] Fix | Delete
[308] Fix | Delete
return $content_media_count;
[309] Fix | Delete
}
[310] Fix | Delete
[311] Fix | Delete
/**
[312] Fix | Delete
* Determines whether to add `fetchpriority='high'` to loading attributes.
[313] Fix | Delete
*
[314] Fix | Delete
* @param array $loading_attrs Array of the loading optimization attributes for the element.
[315] Fix | Delete
* @param array $attr Array of the attributes for the element.
[316] Fix | Delete
* @return array Updated loading optimization attributes for the element.
[317] Fix | Delete
*/
[318] Fix | Delete
private function maybe_add_fetchpriority_high_attr( $loading_attrs, $attr ) {
[319] Fix | Delete
if ( isset( $attr['fetchpriority'] ) ) {
[320] Fix | Delete
if ( 'high' === $attr['fetchpriority'] ) {
[321] Fix | Delete
$loading_attrs['fetchpriority'] = 'high';
[322] Fix | Delete
$this->high_priority_element_flag( false );
[323] Fix | Delete
}
[324] Fix | Delete
[325] Fix | Delete
return $loading_attrs;
[326] Fix | Delete
}
[327] Fix | Delete
[328] Fix | Delete
// Lazy-loading and `fetchpriority="high"` are mutually exclusive.
[329] Fix | Delete
if ( isset( $loading_attrs['loading'] ) && 'lazy' === $loading_attrs['loading'] ) {
[330] Fix | Delete
return $loading_attrs;
[331] Fix | Delete
}
[332] Fix | Delete
[333] Fix | Delete
if ( ! $this->high_priority_element_flag() ) {
[334] Fix | Delete
return $loading_attrs;
[335] Fix | Delete
}
[336] Fix | Delete
[337] Fix | Delete
if ( $this->get_min_priority_img_pixels() <= $attr['width'] * $attr['height'] ) {
[338] Fix | Delete
$loading_attrs['fetchpriority'] = 'high';
[339] Fix | Delete
$this->high_priority_element_flag( false );
[340] Fix | Delete
}
[341] Fix | Delete
[342] Fix | Delete
return $loading_attrs;
[343] Fix | Delete
}
[344] Fix | Delete
[345] Fix | Delete
/**
[346] Fix | Delete
* Accesses a flag that indicates if an element is a possible candidate for `fetchpriority='high'`.
[347] Fix | Delete
*
[348] Fix | Delete
* @param bool $value Optional. Used to change the static variable. Default null.
[349] Fix | Delete
* @return bool Returns true if high-priority element was marked already, otherwise false.
[350] Fix | Delete
*/
[351] Fix | Delete
private function high_priority_element_flag( $value = null ) {
[352] Fix | Delete
static $high_priority_element = true;
[353] Fix | Delete
[354] Fix | Delete
if ( is_bool( $value ) ) {
[355] Fix | Delete
$high_priority_element = $value;
[356] Fix | Delete
}
[357] Fix | Delete
[358] Fix | Delete
return $high_priority_element;
[359] Fix | Delete
}
[360] Fix | Delete
}
[361] Fix | Delete
[362] Fix | Delete
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
Function