Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WP\SEO\Generators;

[2] Fix | Delete

[3] Fix | Delete

use Error;

[4] Fix | Delete

use Yoast\WP\SEO\Context\Meta_Tags_Context;

[5] Fix | Delete

use Yoast\WP\SEO\Helpers\Image_Helper;

[6] Fix | Delete

use Yoast\WP\SEO\Helpers\Open_Graph\Image_Helper as Open_Graph_Image_Helper;

[7] Fix | Delete

use Yoast\WP\SEO\Helpers\Options_Helper;

[8] Fix | Delete

use Yoast\WP\SEO\Helpers\Url_Helper;

[9] Fix | Delete

use Yoast\WP\SEO\Models\Indexable;

[10] Fix | Delete

use Yoast\WP\SEO\Values\Open_Graph\Images;

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* Represents the generator class for the Open Graph images.

[14] Fix | Delete

[15] Fix | Delete

class Open_Graph_Image_Generator implements Generator_Interface {

[16] Fix | Delete

[17] Fix | Delete

/**

[18] Fix | Delete

* The Open Graph image helper.

[19] Fix | Delete

[20] Fix | Delete

* @var Open_Graph_Image_Helper

[21] Fix | Delete

[22] Fix | Delete

protected $open_graph_image;

[23] Fix | Delete

[24] Fix | Delete

/**

[25] Fix | Delete

* The image helper.

[26] Fix | Delete

[27] Fix | Delete

* @var Image_Helper

[28] Fix | Delete

[29] Fix | Delete

protected $image;

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* The URL helper.

[33] Fix | Delete

[34] Fix | Delete

* @var Url_Helper

[35] Fix | Delete

[36] Fix | Delete

protected $url;

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* The options helper.

[40] Fix | Delete

[41] Fix | Delete

* @var Options_Helper

[42] Fix | Delete

[43] Fix | Delete

private $options;

[44] Fix | Delete

[45] Fix | Delete

/**

[46] Fix | Delete

* Images constructor.

[47] Fix | Delete

[48] Fix | Delete

* @codeCoverageIgnore

[49] Fix | Delete

[50] Fix | Delete

* @param Open_Graph_Image_Helper $open_graph_image Image helper for Open Graph.

[51] Fix | Delete

* @param Image_Helper $image The image helper.

[52] Fix | Delete

* @param Options_Helper $options The options helper.

[53] Fix | Delete

* @param Url_Helper $url The url helper.

[54] Fix | Delete

[55] Fix | Delete

public function __construct(

[56] Fix | Delete

Open_Graph_Image_Helper $open_graph_image,

[57] Fix | Delete

Image_Helper $image,

[58] Fix | Delete

Options_Helper $options,

[59] Fix | Delete

Url_Helper $url

[60] Fix | Delete

) {

[61] Fix | Delete

$this->open_graph_image = $open_graph_image;

[62] Fix | Delete

$this->image = $image;

[63] Fix | Delete

$this->options = $options;

[64] Fix | Delete

$this->url = $url;

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

/**

[68] Fix | Delete

* Retrieves the images for an indexable.

[69] Fix | Delete

[70] Fix | Delete

* For legacy reasons some plugins might expect we filter a WPSEO_Opengraph_Image object. That might cause

[71] Fix | Delete

* type errors. This is why we try/catch our filters.

[72] Fix | Delete

[73] Fix | Delete

* @param Meta_Tags_Context $context The context.

[74] Fix | Delete

[75] Fix | Delete

* @return array The images.

[76] Fix | Delete

[77] Fix | Delete

public function generate( Meta_Tags_Context $context ) {

[78] Fix | Delete

$image_container = $this->get_image_container();

[79] Fix | Delete

$backup_image_container = $this->get_image_container();

[80] Fix | Delete

[81] Fix | Delete

try {

[82] Fix | Delete

/**

[83] Fix | Delete

* Filter: wpseo_add_opengraph_images - Allow developers to add images to the Open Graph tags.

[84] Fix | Delete

[85] Fix | Delete

* @param Yoast\WP\SEO\Values\Open_Graph\Images $image_container The current object.

[86] Fix | Delete

[87] Fix | Delete

\apply_filters( 'wpseo_add_opengraph_images', $image_container );

[88] Fix | Delete

} catch ( Error $error ) {

[89] Fix | Delete

$image_container = $backup_image_container;

[90] Fix | Delete

}

[91] Fix | Delete

[92] Fix | Delete

$this->add_from_indexable( $context->indexable, $image_container );

[93] Fix | Delete

$backup_image_container = $image_container;

[94] Fix | Delete

[95] Fix | Delete

try {

[96] Fix | Delete

/**

[97] Fix | Delete

* Filter: wpseo_add_opengraph_additional_images - Allows to add additional images to the Open Graph tags.

[98] Fix | Delete

[99] Fix | Delete

* @param Yoast\WP\SEO\Values\Open_Graph\Images $image_container The current object.

[100] Fix | Delete

[101] Fix | Delete

\apply_filters( 'wpseo_add_opengraph_additional_images', $image_container );

[102] Fix | Delete

} catch ( Error $error ) {

[103] Fix | Delete

$image_container = $backup_image_container;

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

$this->add_from_templates( $context, $image_container );

[107] Fix | Delete

$this->add_from_default( $image_container );

[108] Fix | Delete

[109] Fix | Delete

return $image_container->get_images();

[110] Fix | Delete

}

[111] Fix | Delete

[112] Fix | Delete

/**

[113] Fix | Delete

* Retrieves the images for an author archive indexable.

[114] Fix | Delete

[115] Fix | Delete

* This is a custom method to address the case of Author Archives, since they always have an Open Graph image

[116] Fix | Delete

* set in the indexable (even if it is an empty default Gravatar).

[117] Fix | Delete

[118] Fix | Delete

* @param Meta_Tags_Context $context The context.

[119] Fix | Delete

[120] Fix | Delete

* @return array The images.

[121] Fix | Delete

[122] Fix | Delete

public function generate_for_author_archive( Meta_Tags_Context $context ) {

[123] Fix | Delete

$image_container = $this->get_image_container();

[124] Fix | Delete

[125] Fix | Delete

$this->add_from_templates( $context, $image_container );

[126] Fix | Delete

if ( $image_container->has_images() ) {

[127] Fix | Delete

return $image_container->get_images();

[128] Fix | Delete

}

[129] Fix | Delete

[130] Fix | Delete

return $this->generate( $context );

[131] Fix | Delete

}

[132] Fix | Delete

[133] Fix | Delete

/**

[134] Fix | Delete

* Adds an image based on the given indexable.

[135] Fix | Delete

[136] Fix | Delete

* @param Indexable $indexable The indexable.

[137] Fix | Delete

* @param Images $image_container The image container.

[138] Fix | Delete

[139] Fix | Delete

* @return void

[140] Fix | Delete

[141] Fix | Delete

protected function add_from_indexable( Indexable $indexable, Images $image_container ) {

[142] Fix | Delete

if ( $indexable->open_graph_image_meta ) {

[143] Fix | Delete

$image_container->add_image_by_meta( $indexable->open_graph_image_meta );

[144] Fix | Delete

return;

[145] Fix | Delete

}

[146] Fix | Delete

[147] Fix | Delete

if ( $indexable->open_graph_image_id ) {

[148] Fix | Delete

$image_container->add_image_by_id( $indexable->open_graph_image_id );

[149] Fix | Delete

return;

[150] Fix | Delete

}

[151] Fix | Delete

[152] Fix | Delete

if ( $indexable->open_graph_image ) {

[153] Fix | Delete

$meta_data = [];

[154] Fix | Delete

if ( $indexable->open_graph_image_meta && \is_string( $indexable->open_graph_image_meta ) ) {

[155] Fix | Delete

$meta_data = \json_decode( $indexable->open_graph_image_meta, true );

[156] Fix | Delete

}

[157] Fix | Delete

[158] Fix | Delete

$image_container->add_image(

[159] Fix | Delete

\array_merge(

[160] Fix | Delete

(array) $meta_data,

[161] Fix | Delete

[

[162] Fix | Delete

'url' => $indexable->open_graph_image,

[163] Fix | Delete

]

[164] Fix | Delete

)

[165] Fix | Delete

);

[166] Fix | Delete

}

[167] Fix | Delete

}

[168] Fix | Delete

[169] Fix | Delete

/**

[170] Fix | Delete

* Retrieves the default Open Graph image.

[171] Fix | Delete

[172] Fix | Delete

* @param Images $image_container The image container.

[173] Fix | Delete

[174] Fix | Delete

* @return void

[175] Fix | Delete

[176] Fix | Delete

protected function add_from_default( Images $image_container ) {

[177] Fix | Delete

if ( $image_container->has_images() ) {

[178] Fix | Delete

return;

[179] Fix | Delete

}

[180] Fix | Delete

[181] Fix | Delete

$default_image_id = $this->options->get( 'og_default_image_id', '' );

[182] Fix | Delete

if ( $default_image_id ) {

[183] Fix | Delete

$image_container->add_image_by_id( $default_image_id );

[184] Fix | Delete

[185] Fix | Delete

return;

[186] Fix | Delete

}

[187] Fix | Delete

[188] Fix | Delete

$default_image_url = $this->options->get( 'og_default_image', '' );

[189] Fix | Delete

if ( $default_image_url ) {

[190] Fix | Delete

$image_container->add_image_by_url( $default_image_url );

[191] Fix | Delete

}

[192] Fix | Delete

}

[193] Fix | Delete

[194] Fix | Delete

/**

[195] Fix | Delete

* Retrieves the default Open Graph image.

[196] Fix | Delete

[197] Fix | Delete

* @param Meta_Tags_Context $context The context.

[198] Fix | Delete

* @param Images $image_container The image container.

[199] Fix | Delete

[200] Fix | Delete

* @return void

[201] Fix | Delete

[202] Fix | Delete

protected function add_from_templates( Meta_Tags_Context $context, Images $image_container ) {

[203] Fix | Delete

if ( $image_container->has_images() ) {

[204] Fix | Delete

return;

[205] Fix | Delete

}

[206] Fix | Delete

[207] Fix | Delete

if ( $context->presentation->open_graph_image_id ) {

[208] Fix | Delete

$image_container->add_image_by_id( $context->presentation->open_graph_image_id );

[209] Fix | Delete

return;

[210] Fix | Delete

}

[211] Fix | Delete

[212] Fix | Delete

if ( $context->presentation->open_graph_image ) {

[213] Fix | Delete

$image_container->add_image_by_url( $context->presentation->open_graph_image );

[214] Fix | Delete

}

[215] Fix | Delete

}

[216] Fix | Delete

[217] Fix | Delete

/**

[218] Fix | Delete

* Retrieves an instance of the image container.

[219] Fix | Delete

[220] Fix | Delete

* @codeCoverageIgnore

[221] Fix | Delete

[222] Fix | Delete

* @return Images The image container.

[223] Fix | Delete

[224] Fix | Delete

protected function get_image_container() {

[225] Fix | Delete

$image_container = new Images( $this->image, $this->url );

[226] Fix | Delete

$image_container->set_helpers( $this->open_graph_image );

[227] Fix | Delete

[228] Fix | Delete

return $image_container;

[229] Fix | Delete

}

[230] Fix | Delete

}

[231] Fix | Delete

[232] Fix | Delete