- File: image-helper.php
- Full Path: /home/matthif/www/wp-content/plugins/wordpress-seo/src/helpers/image-helper.php
- Date Modified: 02/24/2024 11:29 PM
- File size: 11.36 KB
- MIME-type: text/x-php
- Charset: utf-8
<?php
namespace Yoast\WP\SEO\Helpers;
use WPSEO_Image_Utils;
use Yoast\WP\SEO\Models\SEO_Links;
use Yoast\WP\SEO\Repositories\Indexable_Repository;
use Yoast\WP\SEO\Repositories\SEO_Links_Repository;
/**
* A helper object for images.
*/
class Image_Helper {
/**
* Image types that are supported by Open Graph.
*
* @var array
*/
protected static $valid_image_types = [ 'image/jpeg', 'image/gif', 'image/png', 'image/webp' ];
/**
* Image extensions that are supported by Open Graph.
*
* @var array
*/
protected static $valid_image_extensions = [ 'jpeg', 'jpg', 'gif', 'png', 'webp' ];
/**
* Represents the indexables repository.
*
* @var Indexable_Repository
*/
protected $indexable_repository;
/**
* Represents the SEO Links repository.
*
* @var SEO_Links_Repository
*/
protected $seo_links_repository;
/**
* The options helper.
*
* @var Options_Helper
*/
private $options_helper;
/**
* The URL helper.
*
* @var Url_Helper
*/
private $url_helper;
/**
* Image_Helper constructor.
*
* @param Indexable_Repository $indexable_repository The indexable repository.
* @param SEO_Links_Repository $seo_links_repository The SEO Links repository.
* @param Options_Helper $options The options helper.
* @param Url_Helper $url_helper The URL helper.
*/
public function __construct(
Indexable_Repository $indexable_repository,
SEO_Links_Repository $seo_links_repository,
Options_Helper $options,
Url_Helper $url_helper
) {
$this->indexable_repository = $indexable_repository;
$this->seo_links_repository = $seo_links_repository;
$this->options_helper = $options;
$this->url_helper = $url_helper;
}
/**
* Determines whether or not the wanted attachment is considered valid.
*
* @param int $attachment_id The attachment ID to get the attachment by.
*
* @return bool Whether or not the attachment is valid.
*/
public function is_valid_attachment( $attachment_id ) {
if ( ! \wp_attachment_is_image( $attachment_id ) ) {
return false;
}
$post_mime_type = \get_post_mime_type( $attachment_id );
if ( $post_mime_type === false ) {
return false;
}
return $this->is_valid_image_type( $post_mime_type );
}
/**
* Checks if the given extension is a valid extension
*
* @param string $image_extension The image extension.
*
* @return bool True when valid.
*/
public function is_extension_valid( $image_extension ) {
return \in_array( $image_extension, static::$valid_image_extensions, true );
}
/**
* Determines whether the passed mime type is a valid image type.
*
* @param string $mime_type The detected mime type.
*
* @return bool Whether or not the attachment is a valid image type.
*/
public function is_valid_image_type( $mime_type ) {
return \in_array( $mime_type, static::$valid_image_types, true );
}
/**
* Retrieves the image source for an attachment.
*
* @param int $attachment_id The attachment.
* @param string $image_size The image size to retrieve.
*
* @return string The image url or an empty string when not found.
*/
public function get_attachment_image_source( $attachment_id, $image_size = 'full' ) {
$attachment = \wp_get_attachment_image_src( $attachment_id, $image_size );
if ( ! $attachment ) {
return '';
}
return $attachment[0];
}
/**
* Retrieves the ID of the featured image.
*
* @param int $post_id The post id to get featured image id for.
*
* @return int|bool ID when found, false when not.
*/
public function get_featured_image_id( $post_id ) {
if ( ! \has_post_thumbnail( $post_id ) ) {
return false;
}
return \get_post_thumbnail_id( $post_id );
}
/**
* Gets the image url from the content.
*
* @param int $post_id The post id to extract the images from.
*
* @return string The image url or an empty string when not found.
*/
public function get_post_content_image( $post_id ) {
$image_url = $this->get_first_usable_content_image_for_post( $post_id );
if ( $image_url === null ) {
return '';
}
return $image_url;
}
/**
* Gets the first image url of a gallery.
*
* @param int $post_id Post ID to use.
*
* @return string The image url or an empty string when not found.
*/
public function get_gallery_image( $post_id ) {
$post = \get_post( $post_id );
if ( \strpos( $post->post_content, '[gallery' ) === false ) {
return '';
}
$images = \get_post_gallery_images( $post );
if ( empty( $images ) ) {
return '';
}
return \reset( $images );
}
/**
* Gets the image url from the term content.
*
* @param int $term_id The term id to extract the images from.
*
* @return string The image url or an empty string when not found.
*/
public function get_term_content_image( $term_id ) {
$image_url = $this->get_first_content_image_for_term( $term_id );
if ( $image_url === null ) {
return '';
}
return $image_url;
}
/**
* Retrieves the caption for an attachment.
*
* @param int $attachment_id Attachment ID.
*
* @return string The caption when found, empty string when no caption is found.
*/
public function get_caption( $attachment_id ) {
$caption = \wp_get_attachment_caption( $attachment_id );
if ( ! empty( $caption ) ) {
return $caption;
}
$caption = \get_post_meta( $attachment_id, '_wp_attachment_image_alt', true );
if ( ! empty( $caption ) ) {
return $caption;
}
return '';
}
/**
* Retrieves the attachment metadata.
*
* @param int $attachment_id Attachment ID.
*
* @return array The metadata, empty array when no metadata is found.
*/
public function get_metadata( $attachment_id ) {
$metadata = \wp_get_attachment_metadata( $attachment_id );
if ( ! $metadata || ! \is_array( $metadata ) ) {
return [];
}
return $metadata;
}
/**
* Retrieves the attachment image url.
*
* @param int $attachment_id Attachment ID.
* @param string $size The size to get.
*
* @return string The url when found, empty string otherwise.
*/
public function get_attachment_image_url( $attachment_id, $size ) {
$url = \wp_get_attachment_image_url( $attachment_id, $size );
if ( ! $url ) {
return '';
}
return $url;
}
/**
* Find the right version of an image based on size.
*
* @codeCoverageIgnore - We have to write test when this method contains own code.
*
* @param int $attachment_id Attachment ID.
* @param string $size Size name.
*
* @return array|false Returns an array with image data on success, false on failure.
*/
public function get_image( $attachment_id, $size ) {
return WPSEO_Image_Utils::get_image( $attachment_id, $size );
}
/**
* Retrieves the best attachment variation for the given attachment.
*
* @codeCoverageIgnore - We have to write test when this method contains own code.
*
* @param int $attachment_id The attachment id.
*
* @return bool|string The attachment url or false when no variations found.
*/
public function get_best_attachment_variation( $attachment_id ) {
$variations = WPSEO_Image_Utils::get_variations( $attachment_id );
$variations = WPSEO_Image_Utils::filter_usable_file_size( $variations );
// If we are left without variations, there is no valid variation for this attachment.
if ( empty( $variations ) ) {
return false;
}
// The variations are ordered so the first variations is by definition the best one.
return \reset( $variations );
}
/**
* Find an attachment ID for a given URL.
*
* @param string $url The URL to find the attachment for.
* @param bool $use_link_table Whether the SEO Links table will be used to retrieve the id.
*
* @return int The found attachment ID, or 0 if none was found.
*/
public function get_attachment_by_url( $url, $use_link_table = true ) {
// Don't try to do this for external URLs.
if ( $this->url_helper->get_link_type( $url ) === SEO_Links::TYPE_EXTERNAL ) {
return 0;
}
/** The `wpseo_force_creating_and_using_attachment_indexables` filter is documented in indexable-link-builder.php */
if ( ! $this->options_helper->get( 'disable-attachment' ) || \apply_filters( 'wpseo_force_creating_and_using_attachment_indexables', false ) ) {
// Strip out the size part of an image URL.
$url = \preg_replace( '/(.*)-\d+x\d+\.(jpeg|jpg|png|gif)$/', '$1.$2', $url );
$indexable = $this->indexable_repository->find_by_permalink( $url );
if ( $indexable && $indexable->object_type === 'post' && $indexable->object_sub_type === 'attachment' ) {
return $indexable->object_id;
}
$post_id = WPSEO_Image_Utils::get_attachment_by_url( $url );
if ( $post_id !== 0 ) {
// Find the indexable, this triggers creating it so it can be found next time.
$this->indexable_repository->find_by_id_and_type( $post_id, 'post' );
}
return $post_id;
}
if ( ! $use_link_table ) {
return WPSEO_Image_Utils::get_attachment_by_url( $url );
}
$link = $this->seo_links_repository->find_one_by_url( $url );
if ( ! \is_a( $link, SEO_Links::class ) ) {
return WPSEO_Image_Utils::get_attachment_by_url( $url );
}
return $link->target_post_id;
}
/**
* Retrieves an attachment ID for an image uploaded in the settings.
*
* Due to self::get_attachment_by_url returning 0 instead of false.
* 0 is also a possibility when no ID is available.
*
* @codeCoverageIgnore - We have to write test when this method contains own code.
*
* @param string $setting The setting the image is stored in.
*
* @return int|bool The attachment id, or false or 0 if no ID is available.
*/
public function get_attachment_id_from_settings( $setting ) {
return WPSEO_Image_Utils::get_attachment_id_from_settings( $setting );
}
/**
* Based on and image ID return array with the best variation of that image. If it's not saved to the DB, save it to an option.
*
* @param string $setting The setting name. Should be company or person.
*
* @return array|bool Array with image details when the image is found, boolean when it's not found.
*/
public function get_attachment_meta_from_settings( $setting ) {
$image_meta = $this->options_helper->get( $setting . '_meta', false );
if ( ! $image_meta ) {
$image_id = $this->options_helper->get( $setting . '_id', false );
if ( $image_id ) {
// There is not an option to put a URL in an image field in the settings anymore, only to upload it through the media manager.
// This means an attachment always exists, so doing this is only needed once.
$image_meta = $this->get_best_attachment_variation( $image_id );
if ( $image_meta ) {
$this->options_helper->set( $setting . '_meta', $image_meta );
}
}
}
return $image_meta;
}
/**
* Retrieves the first usable content image for a post.
*
* @codeCoverageIgnore - We have to write test when this method contains own code.
*
* @param int $post_id The post id to extract the images from.
*
* @return string|null
*/
protected function get_first_usable_content_image_for_post( $post_id ) {
return WPSEO_Image_Utils::get_first_usable_content_image_for_post( $post_id );
}
/**
* Gets the term's first usable content image. Null if none is available.
*
* @codeCoverageIgnore - We have to write test when this method contains own code.
*
* @param int $term_id The term id.
*
* @return string|null The image URL.
*/
protected function get_first_content_image_for_term( $term_id ) {
return WPSEO_Image_Utils::get_first_content_image_for_term( $term_id );
}
}