Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WP\SEO\Helpers\Open_Graph;

[2] Fix | Delete

[3] Fix | Delete

use Yoast\WP\SEO\Helpers\Image_Helper as Base_Image_Helper;

[4] Fix | Delete

use Yoast\WP\SEO\Helpers\Url_Helper;

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* A helper object for Open Graph images.

[8] Fix | Delete

[9] Fix | Delete

class Image_Helper {

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* The URL helper.

[13] Fix | Delete

[14] Fix | Delete

* @var Url_Helper

[15] Fix | Delete

[16] Fix | Delete

private $url;

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* The base image helper.

[20] Fix | Delete

[21] Fix | Delete

* @var Base_Image_Helper

[22] Fix | Delete

[23] Fix | Delete

private $image;

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* Image_Helper constructor.

[27] Fix | Delete

[28] Fix | Delete

* @codeCoverageIgnore

[29] Fix | Delete

[30] Fix | Delete

* @param Url_Helper $url The url helper.

[31] Fix | Delete

* @param Base_Image_Helper $image The image helper.

[32] Fix | Delete

[33] Fix | Delete

public function __construct( Url_Helper $url, Base_Image_Helper $image ) {

[34] Fix | Delete

$this->url = $url;

[35] Fix | Delete

$this->image = $image;

[36] Fix | Delete

}

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* Determines whether the passed URL is considered valid.

[40] Fix | Delete

[41] Fix | Delete

* @deprecated 22.4

[42] Fix | Delete

* @codeCoverageIgnore

[43] Fix | Delete

[44] Fix | Delete

* @param array<array<string,string|int>> $image The image array.

[45] Fix | Delete

[46] Fix | Delete

* @return bool Whether or not the URL is a valid image.

[47] Fix | Delete

[48] Fix | Delete

public function is_image_url_valid( array $image ) {

[49] Fix | Delete

\_deprecated_function( __METHOD__, 'Yoast SEO 22.4' );

[50] Fix | Delete

[51] Fix | Delete

if ( empty( $image['url'] ) || ! \is_string( $image['url'] ) ) {

[52] Fix | Delete

return false;

[53] Fix | Delete

}

[54] Fix | Delete

[55] Fix | Delete

$image_extension = $this->url->get_extension_from_url( $image['url'] );

[56] Fix | Delete

$is_valid = $this->image->is_extension_valid( $image_extension );

[57] Fix | Delete

[58] Fix | Delete

/**

[59] Fix | Delete

* Filter: 'wpseo_opengraph_is_valid_image_url' - Allows extra validation for an image url.

[60] Fix | Delete

[61] Fix | Delete

* @param bool $is_valid Current validation result.

[62] Fix | Delete

* @param string $url The image url to validate.

[63] Fix | Delete

[64] Fix | Delete

return (bool) \apply_filters( 'wpseo_opengraph_is_valid_image_url', $is_valid, $image['url'] );

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

/**

[68] Fix | Delete

* Retrieves the overridden image size value.

[69] Fix | Delete

[70] Fix | Delete

* @return string|null The image size when overriden by filter or null when not.

[71] Fix | Delete

[72] Fix | Delete

public function get_override_image_size() {

[73] Fix | Delete

/**

[74] Fix | Delete

* Filter: 'wpseo_opengraph_image_size' - Allow overriding the image size used

[75] Fix | Delete

* for Open Graph sharing. If this filter is used, the defined size will always be

[76] Fix | Delete

* used for the og:image. The image will still be rejected if it is too small.

[77] Fix | Delete

[78] Fix | Delete

* Only use this filter if you manually want to determine the best image size

[79] Fix | Delete

* for the `og:image` tag.

[80] Fix | Delete

[81] Fix | Delete

* Use the `wpseo_image_sizes` filter if you want to use our logic. That filter

[82] Fix | Delete

* can be used to add an image size that needs to be taken into consideration

[83] Fix | Delete

* within our own logic.

[84] Fix | Delete

[85] Fix | Delete

* @param string|false $size Size string.

[86] Fix | Delete

[87] Fix | Delete

return \apply_filters( 'wpseo_opengraph_image_size', null );

[88] Fix | Delete

}

[89] Fix | Delete

[90] Fix | Delete

/**

[91] Fix | Delete

* Retrieves the image data by a given attachment id.

[92] Fix | Delete

[93] Fix | Delete

* @param int $attachment_id The attachment id.

[94] Fix | Delete

[95] Fix | Delete

* @return array<string,string|int>|false The image data when found, `false` when not.

[96] Fix | Delete

[97] Fix | Delete

public function get_image_by_id( $attachment_id ) {

[98] Fix | Delete

if ( ! $this->image->is_valid_attachment( $attachment_id ) ) {

[99] Fix | Delete

return false;

[100] Fix | Delete

}

[101] Fix | Delete

[102] Fix | Delete

$override_image_size = $this->get_override_image_size();

[103] Fix | Delete

if ( $override_image_size ) {

[104] Fix | Delete

return $this->image->get_image( $attachment_id, $override_image_size );

[105] Fix | Delete

}

[106] Fix | Delete

[107] Fix | Delete

return $this->image->get_best_attachment_variation( $attachment_id );

[108] Fix | Delete

}

[109] Fix | Delete

}

[110] Fix | Delete

[111] Fix | Delete