*/
final class Optml_Tag_Replacer extends Optml_App_Replacer {
use Optml_Normalizer;
use Optml_Validator;
use Optml_Dam_Offload_Utils;
/**
* Cached object instance.
*
* @var Optml_Tag_Replacer
*/
protected static $instance = null;
/**
* The number of images skipped from lazyload.
*
* @var integer
*/
public static $lazyload_skipped_images = 0;
/**
* Class instance method.
*
* @codeCoverageIgnore
* @static
* @since 1.0.0
* @access public
* @return Optml_Tag_Replacer
*/
public static function instance() {
if ( null === self::$instance ) {
self::$instance = new self();
add_action( 'optml_replacer_setup', [ self::$instance, 'init' ] );
}
return self::$instance;
}
/**
* The initialize method.
*/
public function init() {
parent::init();
add_filter( 'optml_content_images_tags', [ $this, 'process_image_tags' ], 1, 2 );
if ( ! $this->settings->use_lazyload() ) {
add_filter( 'optml_tag_replace', [ $this, 'regular_tag_replace' ], 1, 6 );
}
add_filter( 'image_downsize', [ $this, 'filter_image_downsize' ], PHP_INT_MAX, 3 );
add_filter( 'wp_calculate_image_srcset', [ $this, 'filter_srcset_attr' ], PHP_INT_MAX - 1, 5 );
add_filter( 'wp_calculate_image_sizes', [ $this, 'filter_sizes_attr' ], 1, 2 );
add_filter( 'wp_image_src_get_dimensions', [ $this, 'filter_image_src_get_dimensions' ], 99, 4 );
if ( $this->settings->get( 'retina_images' ) === 'enabled' ) {
add_filter( 'wp_get_attachment_image_attributes', [ $this, 'filter_attachment_image_attributes' ], 99, 3 );
}
}
/**
* We have to short-circuit the logic that adds width and height to the img tag.
* It compares the URL basename, and the `file` param for each image.
* This happens for any image that gets its size set non-explicitly
* e.g. an image block with its size set from the sidebar to `thumbnail`).
*
* Optimole has a single basename for all image resizes in its URL.
*
* @param mixed $dimensions The dimensions of the image.
* @param mixed $image_src The source of the image.
* @param mixed $image_meta The meta of the image.
* @param mixed $attachment_id The ID of the attachment.
*/
public function filter_image_src_get_dimensions( $dimensions, $image_src, $image_meta, $attachment_id ) {
list($width, $height) = $this->parse_dimension_from_optimized_url( $image_src );
if ( false === $width || false === $height ) {
return $dimensions;
}
$sizes = Optml_App_Replacer::image_sizes();
if ( OPTML_DEBUG ) {
do_action( 'optml_log', 'filter_image_src_get_dimensions: ' . $image_src . ' ' . $width . ' ' . $height . ' ' . print_r( $image_meta, true ) );
}
if ( $width === 'auto' && $height === 'auto' && isset( $image_meta['width'], $image_meta['height'] ) ) {
return [
$image_meta['width'],
$image_meta['height'],
];
}
// If this is an image size. Return its dimensions.
foreach ( $sizes as $size => $args ) {
if ( (int) $args['width'] !== (int) $width ) {
continue;
}
if ( (int) $args['height'] !== (int) $height ) {
continue;
}
return [
$args['width'],
$args['height'],
];
}
// Fall-through with the original dimensions.
return $dimensions;
}
/**
* Filter the attachment image attributes to add the srcset attribute with retina support.
*
* This is covering the case where the image has no sizes.
*
* @param array $attr The attributes.
* @param WP_Post $attachment The attachment.
* @param string $size The size.
*/
public function filter_attachment_image_attributes( $attr, $attachment, $size ) {
if ( ! isset( $attr['srcset'] ) && isset( $attr['src'] ) && strpos( $attr['src'], '/w:' ) !== false ) {
$attr['srcset'] = str_replace( '/w:', '/dpr:2/w:', $attr['src'] ) . ' 2x';
}
return $attr;
}
/**
* Replace in given content the given image tags with video tags is image is gif
*
* @param string $image_url Image url to process.
* @param string $image_tag The tag to replace.
* @param string $content The content to process.
*
* @return bool
*/
public function img_to_video( $image_url, $image_tag, &$content ) {
if ( $this->settings->get( 'img_to_video' ) === 'disabled' ) {
return false;
}
if ( false === Optml_Filters::should_do_image( $image_tag, apply_filters( 'optml_gif_to_video_flags', [ 'lazyload' => true, 'placeholder' => true, 'original-src' => true ] ) ) ) {
return false;
}
$link_mp4 = apply_filters(
'optml_content_url',
$image_url,
[
'width' => 'auto',
'height' => 'auto',
'format' => 'mp4',
]
);
$link_png = apply_filters(
'optml_content_url',
$image_url,
[
'width' => 'auto',
'height' => 'auto',
'quality' => 'eco',
]
);
$video_tag = $image_tag;
$video_tag = str_replace(
[
'src=',
'
',
],
[
'original-src=',
'',
],
$video_tag
);
$content = str_replace( $image_tag, $video_tag, $content );
return true;
}
/**
* Method invoked by `optml_content_images_tags` filter.
*
* @param string $content The content to be processed.
* @param array $images A list of images.
*
* @return mixed
*/
public function process_image_tags( $content, $images = [] ) {
$image_sizes = self::image_sizes();
$sizes2crop = self::size_to_crop();
if ( OPTML_DEBUG ) {
do_action( 'optml_log', 'Images tags to process: ' . print_r( $images, true ) );
}
foreach ( $images[0] as $index => $tag ) {
$width = $height = false;
$crop = null;
$image_tag = $images['img_tag'][ $index ];
$is_slashed = strpos( $images['img_url'][ $index ], '\/' ) !== false;
$src = $tmp = $is_slashed ? $this->strip_slashes( $images['img_url'][ $index ] ) : $images['img_url'][ $index ];
if ( strpos( $src, $this->upload_resource['content_path'] ) === 0 ) {
$src = $tmp = untrailingslashit( $this->upload_resource['content_host'] ) . $src;
$new_src = $is_slashed ? addcslashes( $src, '/' ) : $src;
$image_tag = str_replace(
[
'"' . $images['img_url'][ $index ],
"'" . $images['img_url'][ $index ],
],
[
'"' . $new_src,
"'" . $new_src,
],
$image_tag
);
$images['img_url'][ $index ] = $new_src;
}
if ( ( apply_filters( 'optml_ignore_image_link', false, $src ) ||
! $this->can_replace_tag( $images['img_url'][ $index ], $tag ) ) && ! Optml_Media_Offload::is_not_processed_image( $src )
) {
continue; // @codeCoverageIgnore
}
$resize = apply_filters( 'optml_default_crop', [] );
list( $width, $height, $resize ) = self::parse_dimensions_from_tag(
$images['img_tag'][ $index ],
$image_sizes,
[
'width' => $width,
'height' => $height,
'resize' => $resize,
]
);
if ( false === $width && false === $height ) {
list( $width, $height, $crop ) = $this->parse_dimensions_from_filename( $tmp );
}
if ( empty( $resize ) && isset( $sizes2crop[ $width . $height ] ) ) {
$resize = $this->to_optml_crop( $sizes2crop[ $width . $height ] );
} elseif ( $crop === true ) {
$resize = $this->to_optml_crop( $crop );
}
$optml_args = [ 'width' => $width, 'height' => $height, 'resize' => $resize ];
$is_gif = $this->is_valid_gif( $images['img_url'][ $index ] );
$should_lazy_gif = $is_gif ? $this->should_lazy_gif( $images['img_url'][ $index ], $optml_args ) : null;
if ( $should_lazy_gif === true && $this->img_to_video( $images['img_url'][ $index ], $images['img_tag'][ $index ], $content ) ) {
continue;
}
$tmp = $this->strip_image_size_from_url( $tmp );
$image_id = $this->get_id_by_url( $images['img_url'][ $index ] );
if ( Optml_Manager::instance()->page_profiler->get_crop_status( $image_id ) && empty( $optml_args['resize'] ) ) {
$optml_args['resize'] = $this->to_optml_crop( true );
$optml_args['force'] = true; // here we need to force the url to be rebuild if the image is already using an Optimole URL.
}
$new_url = apply_filters( 'optml_content_url', $tmp, $optml_args );
$image_tag = str_replace(
[
'width="' . $width . '"',
'width=\"' . $width . '\"',
'height="' . $height . '"',
'height=\"' . $height . '\"',
],
[
'width="' . $optml_args['width'] . '"',
'width=\"' . $optml_args['width'] . '\"',
'height="' . $optml_args['height'] . '"',
'height=\"' . $optml_args['height'] . '\"',
],
$image_tag
);
// If the image is in header or has a class excluded from lazyload or is an excluded gif, we need to do the regular replace.
if ( $images['in_no_script'][ $index ] || $should_lazy_gif === false ) {
$image_tag = $this->regular_tag_replace( $image_tag, $images['img_url'][ $index ], $new_url, $optml_args, $is_slashed, $tag );
} else {
$image_tag = apply_filters( 'optml_tag_replace', $image_tag, $images['img_url'][ $index ], $new_url, $optml_args, $is_slashed, $tag );
}
if ( strpos( $image_tag, 'data-opt-id=' ) === false ) {
$image_tag = preg_replace( '/
is_valid_numeric( $optml_args['width'] ) && $this->is_valid_numeric( $optml_args['height'] ) && min( $optml_args['height'], $optml_args['width'] ) <= 20 ) {
return false;
}
return true;
}
/**
* Check replacement is allowed for this tag.
*
* @param string $url Url.
* @param string $tag Html tag.
*
* @return bool We can replace?
*/
public function can_replace_tag( $url, $tag = '' ) {
foreach ( self::possible_tag_flags() as $banned_string ) {
if ( strpos( $tag, $banned_string ) !== false ) {
self::$ignored_url_map[ crc32( $url ) ] = true;
return false;
}
}
return true;
}
/**
* Extract image dimensions from img tag.
*
* @param string $tag The HTML img tag.
* @param array $image_sizes WordPress supported image sizes.
* @param array $args Default args to use.
*
* @return array
*/
private function parse_dimensions_from_tag( $tag, $image_sizes, $args = [] ) {
if ( preg_match( '#width=["|\']?([\d%]+)["|\']?#i', $tag, $width_string ) ) {
if ( ctype_digit( $width_string[1] ) === true ) {
$args['width'] = $width_string[1];
}
}
if ( preg_match( '#height=["|\']?([\d%]+)["|\']?#i', $tag, $height_string ) ) {
if ( ctype_digit( $height_string[1] ) === true ) {
$args['height'] = $height_string[1];
}
}
if ( preg_match( '#class=["|\']?[^"\']*size-([^"\'\s]+)[^"\']*["|\']?#i', $tag, $size ) ) {
$size = array_pop( $size );
if ( false === $args['width'] && false === $args['height'] && 'full' !== $size && array_key_exists( $size, $image_sizes ) ) {
$args['width'] = (int) $image_sizes[ $size ]['width'];
$args['height'] = (int) $image_sizes[ $size ]['height'];
}
if ( 'full' !== $size && array_key_exists( $size, $image_sizes ) ) {
$args['resize'] = $this->to_optml_crop( $image_sizes[ $size ]['crop'] );
}
} else {
$args['resize'] = apply_filters( 'optml_parse_resize_from_tag', [], $tag );
}
return [ $args['width'], $args['height'], $args['resize'] ];
}
/**
* Replaces the tags by default.
*
* @param string $new_tag The new tag.
* @param string $original_url The original URL.
* @param string $new_url The optimized URL.
* @param array $optml_args Options passed for URL optimization.
* @param bool $is_slashed Url needs to slashed.
* @param string $full_tag Full tag, wrapper included.
*
* @return string
*/
public function regular_tag_replace( $new_tag, $original_url, $new_url, $optml_args, $is_slashed = false, $full_tag = '' ) {
if ( OPTML_DEBUG ) {
do_action( 'optml_log', 'regular_tag_replace: ' . $original_url . ' ' . $new_url . $new_tag );
}
$pattern = '/(?get_id_by_url( $original_url );
// Add missing srcset attributes based on measurements from JavaScript module
$missing_srcsets = Optml_Manager::instance()->page_profiler->get_missing_srcsets( $image_id );
if ( ! empty( $missing_srcsets ) ) {
$new_tag = $this->add_missing_srcset_attributes( $new_tag, $missing_srcsets, $new_url, $is_slashed );
}
if ( $this->settings->get( 'lazyload' ) === 'enabled' && $this->settings->get( 'native_lazyload' ) === 'enabled'
&& apply_filters( 'optml_should_load_eager', '__return_true' ) && ! $this->is_valid_gif( $original_url ) ) {
if ( strpos( $new_tag, 'loading=' ) === false ) {
$new_tag = preg_replace( '/
settings->is_lazyload_type_viewport() ) {
$image_id = $this->get_id_by_url( $original_url );
$is_lcp_image = Optml_Manager::instance()->page_profiler->is_lcp_image_in_all_viewports( $image_id );
$no_viewport_data_available = ! Optml_Manager::instance()->page_profiler->is_data_available();
if ( OPTML_DEBUG ) {
do_action( 'optml_log', 'Adding fetchpriority image is LCP ' . $original_url . '|' . $image_id );
}
if ( $is_lcp_image ) {
$new_tag = preg_replace( '/
settings->is_lazyload_type_fixed() &&
self::$lazyload_skipped_images < Optml_Lazyload_Replacer::get_skip_lazyload_limit() &&
false === strpos( $new_tag, 'fetchpriority=' )
) {
$new_tag = preg_replace( '/
$missing_srcsets Array of missing srcset data from JavaScript module.
* @param string $new_url The new image URL.
* @param bool $is_slashed Whether the URL needs to be slashed.
*
* @return string The modified image tag with enhanced srcset attributes.
*/
public function add_missing_srcset_attributes( $tag, $missing_srcsets, $new_url, $is_slashed = false ) {
if ( OPTML_DEBUG ) {
do_action( 'optml_log', 'add_missing_srcset_attributes: ' . $new_url . ' ' . print_r( $missing_srcsets, true ) );
}
if ( empty( $missing_srcsets ) || ! is_array( $missing_srcsets ) ) {
return $tag;
}
// Check if srcset already exists
$has_existing_srcset = strpos( $tag, 'srcset=' ) !== false;
$has_existing_sizes = strpos( $tag, 'sizes=' ) !== false;
// Build new srcset entries from missing srcset data
$new_srcset_entries = [];
$new_sizes_entries = [];
foreach ( $missing_srcsets as $srcset_data ) {
// Validate required fields
if ( ! isset( $srcset_data['w'] ) || ! isset( $srcset_data['h'] ) || ! isset( $srcset_data['s'] ) ) {
continue;
}
$width = (int) $srcset_data['w'];
$height = (int) $srcset_data['h'];
$descriptor = $srcset_data['s']; // e.g., "200w"
$dpr = isset( $srcset_data['d'] ) ? (int) $srcset_data['d'] : 1;
// If the retina images are not enabled, we don't need to add the retina srcset.
if ( $dpr > 1 && $this->settings->get( 'retina_images' ) !== 'enabled' ) {
continue;
}
$breakpoint = isset( $srcset_data['b'] ) ? (int) $srcset_data['b'] : 0;
// Generate optimized URL for this size
$optimized_url = $this->change_url_for_size( $new_url, $width, $height, $dpr );
if ( $optimized_url ) {
$escaped_url = esc_url( $optimized_url );
if ( empty( $escaped_url ) ) {
continue;
}
$new_srcset_entries[] = $escaped_url . ' ' . esc_attr( $descriptor );
// Add sizes attribute entry for responsive breakpoints
if ( $breakpoint > 0 ) {
$new_sizes_entries[] = '(max-width: ' . $breakpoint . 'px) ' . $width . 'px';
}
}
}
if ( empty( $new_srcset_entries ) ) {
return $tag;
}
if ( $has_existing_srcset ) {
// Enhance existing srcset
$tag = $this->enhance_existing_srcset( $tag, $new_srcset_entries, $is_slashed );
} else {
// Add new srcset attribute
$srcset_value = implode( ', ', $new_srcset_entries );
$srcset_attr = $is_slashed ? 'srcset=\"' . addcslashes( $srcset_value, '"' ) . '\"' : 'srcset="' . $srcset_value . '"';
// Insert srcset attribute after the src attribute
$tag = preg_replace( '/(src=["\'][^"\']*["\'])/i', '$1 ' . $srcset_attr, $tag );
}
// Handle sizes attribute - skip if existing sizes contains calc() or complex formulas
if ( ! empty( $new_sizes_entries ) ) {
$should_skip_sizes = false;
if ( $has_existing_sizes ) {
// Check if existing sizes contains calc() or complex formulas
if ( preg_match( '/sizes=["\']([^"\']*)["\']/i', $tag, $matches ) ) {
$existing_sizes = $matches[1];
if ( $this->should_skip_sizes( $existing_sizes ) ) {
$should_skip_sizes = true;
if ( OPTML_DEBUG ) {
do_action( 'optml_log', 'Skipping sizes enhancement due to complex formula: ' . $existing_sizes );
}
}
}
}
if ( ! $should_skip_sizes ) {
// Filter sizes entries to ensure they're appropriate for the container
$filtered_sizes_entries = $this->filter_sizes_entries_for_container( $new_sizes_entries, $tag );
if ( ! empty( $filtered_sizes_entries ) ) {
if ( $has_existing_sizes ) {
// Enhance existing sizes
$tag = $this->enhance_existing_sizes( $tag, $filtered_sizes_entries, $is_slashed );
} else {
// Add new sizes attribute
$sizes_entries = array_unique( $filtered_sizes_entries );
// Sort ascending by breakpoint value (numeric)
usort(
$sizes_entries,
function ( $a, $b ) {
preg_match( '/max-width:\s*(\d+)/', $a, $ma );
preg_match( '/max-width:\s*(\d+)/', $b, $mb );
return ( $ma[1] ?? 0 ) - ( $mb[1] ?? 0 );
}
);
$sizes_value = implode( ', ', $sizes_entries );
$sizes_attr = $is_slashed ? 'sizes=\"' . addcslashes( $sizes_value, '"' ) . '\"' : 'sizes="' . $sizes_value . '"';
// Insert sizes attribute after srcset
$tag = preg_replace( '/(srcset=["\'][^"\']*["\'])/i', '$1 ' . $sizes_attr, $tag );
}
}
} else {
// Log that sizes were skipped due to complex formulas
if ( OPTML_DEBUG ) {
do_action( 'optml_log', 'Skipped adding sizes due to complex formula detection' );
}
}
}
if ( OPTML_DEBUG ) {
$action = $has_existing_srcset ? 'Enhanced' : 'Added';
do_action( 'optml_log', $action . ' srcset for image: ' . $new_url . ' with ' . count( $new_srcset_entries ) . ' new entries' );
}
return $tag;
}
/**
* Enhance existing srcset attribute by adding new entries.
*
* @param string $tag The image tag.
* @param array $new_srcset_entries Array of new srcset entries to add.
* @param bool $is_slashed Whether the URL needs to be slashed.
*
* @return string The modified image tag with enhanced srcset.
*/
public function enhance_existing_srcset( $tag, $new_srcset_entries, $is_slashed = false ) {
// Extract existing srcset value
if ( preg_match( '/srcset=["\']([^"\']*)["\']/i', $tag, $matches ) ) {
$existing_srcset = $matches[1];
$existing_entries = array_map( 'trim', explode( ',', $existing_srcset ) );
// Merge with new entries, avoiding duplicates
$all_entries = array_merge( $existing_entries, $new_srcset_entries );
$all_entries = array_unique( $all_entries );
// Sort by descriptor (width) for better organization
usort(
$all_entries,
function ( $a, $b ) {
preg_match( '/(\d+)w/', $a, $matches_a );
preg_match( '/(\d+)w/', $b, $matches_b );
$width_a = isset( $matches_a[1] ) ? (int) $matches_a[1] : 0;
$width_b = isset( $matches_b[1] ) ? (int) $matches_b[1] : 0;
return $width_a - $width_b;
}
);
$enhanced_srcset = implode( ', ', $all_entries );
$srcset_attr = $is_slashed ? 'srcset=\"' . addcslashes( $enhanced_srcset, '"' ) . '\"' : 'srcset="' . $enhanced_srcset . '"';
// Replace existing srcset
$tag = preg_replace( '/srcset=["\'][^"\']*["\']/i', $srcset_attr, $tag );
}
return $tag;
}
/**
* Enhance existing sizes attribute by adding new breakpoint entries.
*
* @param string $tag The image tag.
* @param array $new_sizes_entries Array of new sizes entries to add.
* @param bool $is_slashed Whether the URL needs to be slashed.
*
* @return string The modified image tag with enhanced sizes.
*/
public function enhance_existing_sizes( $tag, $new_sizes_entries, $is_slashed = false ) {
// Extract existing sizes value
if ( preg_match( '/sizes=["\']([^"\']*)["\']/i', $tag, $matches ) ) {
$existing_sizes = $matches[1];
$existing_entries = array_map( 'trim', explode( ',', $existing_sizes ) );
// Merge with new entries, avoiding duplicates
$all_entries = array_merge( $existing_entries, $new_sizes_entries );
$all_entries = array_unique( $all_entries );
// Sort by breakpoint (descending)
usort(
$all_entries,
function ( $a, $b ) {
preg_match( '/max-width:\s*(\d+)px/', $a, $matches_a );
preg_match( '/max-width:\s*(\d+)px/', $b, $matches_b );
$breakpoint_a = isset( $matches_a[1] ) ? (int) $matches_a[1] : 0;
$breakpoint_b = isset( $matches_b[1] ) ? (int) $matches_b[1] : 0;
return $breakpoint_b - $breakpoint_a; // Descending order
}
);
$enhanced_sizes = implode( ', ', $all_entries );
$sizes_attr = $is_slashed ? 'sizes=\"' . addcslashes( $enhanced_sizes, '"' ) . '\"' : 'sizes="' . $enhanced_sizes . '"';
// Replace existing sizes
$tag = preg_replace( '/sizes=["\'][^"\']*["\']/i', $sizes_attr, $tag );
}
return $tag;
}
/**
* Check if sizes attribute contains complex formulas that should not be modified.
*
* @param string $sizes_value The sizes attribute value.
*
* @return bool True if contains complex formulas, false otherwise.
*/
public function should_skip_sizes( $sizes_value ) {
// Check for calc() functions
if ( strpos( $sizes_value, 'calc(' ) !== false ) {
return true;
}
// Check for complex mathematical operations
if ( preg_match( '/\d+%\s*[+\-*\/]|[+\-*\/]\s*\d+%|\d+px\s*[+\-*\/]|[+\-*\/]\s*\d+px/', $sizes_value ) ) {
return true;
}
// Check for viewport units with calculations
if ( preg_match( '/\d+vw\s*[+\-*\/]|\d+vh\s*[+\-*\/]|\d+vmin\s*[+\-*\/]|\d+vmax\s*[+\-*\/]/', $sizes_value ) ) {
return true;
}
// Check for complex CSS functions
if ( preg_match( '/(min|max|clamp)\(/', $sizes_value ) ) {
return true;
}
// Check for multiple percentage values with operations
if ( preg_match( '/\d+%\s*[+\-*\/]\s*\d+%/', $sizes_value ) ) {
return true;
}
return false;
}
/**
* Filter sizes entries to ensure they're appropriate for the container size.
* This prevents oversized images from being selected for small containers.
*
* @param array $sizes_entries Array of sizes entries from JavaScript module.
* @param string $tag The image tag to extract container dimensions from.
*
* @return array Filtered sizes entries appropriate for the container.
*/
public function filter_sizes_entries_for_container( $sizes_entries, $tag ) {
if ( empty( $sizes_entries ) ) {
return [];
}
// Extract container dimensions from the image tag
$container_width = null;
$container_height = null;
// Try to get width and height from the tag
if ( preg_match( '/width=["\']?(\d+)["\']?/i', $tag, $width_match ) ) {
$container_width = (int) $width_match[1];
}
if ( preg_match( '/height=["\']?(\d+)["\']?/i', $tag, $height_match ) ) {
$container_height = (int) $height_match[1];
}
// If we can't determine container size, return all entries (fallback)
if ( ! $container_width || ! $container_height ) {
if ( OPTML_DEBUG ) {
do_action( 'optml_log', 'Cannot determine container size, using all sizes entries' );
}
return $sizes_entries;
}
// Calculate maximum reasonable size for this container
$max_reasonable_width = $container_width * 1.5; // Allow up to 1.5x the container size
$filtered_entries = [];
foreach ( $sizes_entries as $entry ) {
// Extract image size from the entry (e.g., "(max-width: 768px) 400px" -> 400)
if ( preg_match( '/\(max-width:\s*\d+px\)\s*(\d+)px/', $entry, $matches ) ) {
$image_width = (int) $matches[1];
// Only include entries where the image size is reasonable for the container
if ( $image_width <= $max_reasonable_width ) {
$filtered_entries[] = $entry;
} else {
if ( OPTML_DEBUG ) {
do_action( 'optml_log', "Filtered out oversized entry: {$entry} (container: {$container_width}px, image: {$image_width}px)" );
}
}
} else {
// If we can't parse the entry, include it (better safe than sorry)
$filtered_entries[] = $entry;
}
}
if ( OPTML_DEBUG ) {
do_action( 'optml_log', "Filtered sizes entries for container {$container_width}x{$container_height}: " . count( $filtered_entries ) . ' of ' . count( $sizes_entries ) . ' entries' );
}
return $filtered_entries;
}
/**
* Generate optimized URL for a specific size and DPR.
*
* @param string $original_url The original image URL.
* @param int $width The target width.
* @param int $height The target height.
* @param int $dpr The device pixel ratio.
*
* @return string The optimized URL or false on failure.
*/
public function change_url_for_size( $original_url, $width, $height, $dpr = 1 ) {
// Assume w and h are always present - just replace them
// Updated regex to match w:auto, w:123, h:auto, h:456, etc.
$replacements = [
'/w:(?:auto|\d+)/' => 'w:' . $width,
'/h:(?:auto|\d+)/' => 'h:' . $height,
];
// Handle DPR - replace if exists, add after w: if missing
if ( $dpr > 1 ) {
if ( strpos( $original_url, 'dpr:' ) !== false ) {
$replacements['/dpr:\d+/'] = 'dpr:' . $dpr;
} else {
// Add DPR after width parameter - use the same pattern as width replacement
$replacements['/(w:(?:auto|\d+))/'] = '$1/dpr:' . $dpr;
}
} else {
$replacements['/dpr:\d+\//'] = '';
}
return preg_replace( array_keys( $replacements ), array_values( $replacements ), $original_url );
}
/**
* Replace image URLs in the srcset attributes and in case there is a resize in action, also replace the sizes.
*
* @param array|mixed $sources Array of image sources.
* @param array{0: int, 1: int}|int[] $size_array Array of width and height values in pixels (in that order).
* @param string $image_src The 'src' of the image.
* @param array $image_meta The image meta data as returned by 'wp_get_attachment_metadata()'.
* @param int $attachment_id Image attachment ID or 0.
*
* @return array|mixed
*/
public function filter_srcset_attr( $sources = [], $size_array = [], $image_src = '', $image_meta = [], $attachment_id = 0 ) {
if ( ! is_array( $sources ) ) {
return $sources;
}
if ( Optml_Media_Offload::is_uploaded_image( $image_src ) ) {
return $sources;
}
$original_url = null;
$cropping = null;
if ( count( $size_array ) === 2 ) {
$sizes = self::size_to_crop();
$cropping = isset( $sizes[ $size_array[0] . $size_array[1] ] ) ? $this->to_optml_crop( $sizes[ $size_array[0] . $size_array[1] ] ) : null;
}
if ( OPTML_DEBUG ) {
do_action( 'optml_log', 'sources: ' . print_r( $sources, true ) . ' size_array: ' . print_r( $size_array, true ) );
}
$biggest_size = [];
$max_width = 0;
foreach ( $sources as $i => $source ) {
$url = $source['url'];
if ( Optml_Media_Offload::is_uploaded_image( $url ) ) {
continue;
}
list( $width, $height, $file_crop ) = $this->parse_dimensions_from_filename( $url );
if ( empty( $width ) ) {
$width = $image_meta['width'];
}
if ( empty( $height ) ) {
$height = $image_meta['height'];
}
if ( $original_url === null ) {
if ( ! empty( $attachment_id ) ) {
$original_url = wp_get_attachment_url( $attachment_id );
} else {
$original_url = $this->strip_image_size_from_url( $source['url'] );
}
}
$args = [];
if ( 'w' === $source['descriptor'] ) {
if ( $height && ( $source['value'] === $width ) ) {
$args['width'] = $width;
$args['height'] = $height;
} else {
$args['width'] = $source['value'];
}
}
if ( $cropping !== null ) {
$args['resize'] = $cropping;
} else {
$args['resize'] = $this->to_optml_crop( $file_crop );
}
if ( $i > $max_width ) {
$max_width = $i;
$biggest_size = [ $args, $original_url ];
}
$sources[ $i ]['url'] = apply_filters( 'optml_content_url', $original_url, $args );
}
if ( $this->settings->get( 'retina_images' ) === 'enabled' && ! empty( $biggest_size ) ) {
$sources[ $max_width * 2 ]['url'] = apply_filters( 'optml_content_url', $biggest_size[1], array_merge( $biggest_size[0], [ 'dpr' => 2 ] ) );
$sources[ $max_width * 2 ]['value'] = 2;
$sources[ $max_width * 2 ]['descriptor'] = 'x';
}
return $sources;
}
/**
* Filters sizes attribute of the images.
*
* @param string $sizes An array of media query breakpoints.
* @param string|int[] $size Width and height of the image.
*
* @return string An array of media query breakpoints.
*/
public function filter_sizes_attr( $sizes, $size ) {
if ( ! doing_filter( 'the_content' ) ) {
return $sizes;
}
$content_width = false;
if ( isset( $GLOBALS['content_width'] ) ) {
$content_width = $GLOBALS['content_width'];
}
if ( ! $content_width ) {
$content_width = 1000;
}
if ( is_array( $size ) && $size[0] < $content_width ) {
return $sizes;
}
return sprintf( '(max-width: %1$dpx) 100vw, %1$dpx', $content_width );
}
/**
* This filter will replace all the images retrieved via "wp_get_image" type of functions.
*
* @param array $image The filtered value.
* @param int $attachment_id The related attachment id.
* @param array|string $size This could be the name of the thumbnail size or an array of custom dimensions.
*
* @return array
*/
public function filter_image_downsize( $image, $attachment_id, $size ) {
if ( defined( 'REST_REQUEST' ) && REST_REQUEST ) {
return $image;
}
$image_url = wp_get_attachment_url( $attachment_id );
if ( Optml_Media_Offload::is_uploaded_image( $image_url ) ) {
return $image;
}
if ( $image_url === false ) {
return $image;
}
$image_meta = wp_get_attachment_metadata( $attachment_id );
$sizes = $this->size_to_dimension( $size, $image_meta, $attachment_id );
$image_url = $this->strip_image_size_from_url( $image_url );
$new_url = apply_filters( 'optml_content_url', $image_url, $sizes );
if ( $new_url === $image_url ) {
return $image;
}
return [
$new_url,
$sizes['width'],
$sizes['height'],
$size === 'full',
];
}
/**
* Throw error on object clone
*
* The whole idea of the singleton design pattern is that there is a single
* object therefore, we don't want the object to be cloned.
*
* @codeCoverageIgnore
* @access public
* @since 1.0.0
* @return void
*/
public function __clone() {
// Cloning instances of the class is forbidden.
_doing_it_wrong( __FUNCTION__, esc_html__( 'Cheatin’ huh?', 'optimole-wp' ), '1.0.0' );
}
/**
* Disable unserializing of the class
*
* @codeCoverageIgnore
* @access public
* @since 1.0.0
* @return void
*/
public function __wakeup() {
// Unserializing instances of the class is forbidden.
_doing_it_wrong( __FUNCTION__, esc_html__( 'Cheatin’ huh?', 'optimole-wp' ), '1.0.0' );
}
}