Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WP\SEO\Presentations;

[2] Fix | Delete

[3] Fix | Delete

use Yoast\WP\SEO\Context\Meta_Tags_Context;

[4] Fix | Delete

use Yoast\WP\SEO\Generators\Breadcrumbs_Generator;

[5] Fix | Delete

use Yoast\WP\SEO\Generators\Open_Graph_Image_Generator;

[6] Fix | Delete

use Yoast\WP\SEO\Generators\Open_Graph_Locale_Generator;

[7] Fix | Delete

use Yoast\WP\SEO\Generators\Schema_Generator;

[8] Fix | Delete

use Yoast\WP\SEO\Generators\Twitter_Image_Generator;

[9] Fix | Delete

use Yoast\WP\SEO\Helpers\Current_Page_Helper;

[10] Fix | Delete

use Yoast\WP\SEO\Helpers\Image_Helper;

[11] Fix | Delete

use Yoast\WP\SEO\Helpers\Indexable_Helper;

[12] Fix | Delete

use Yoast\WP\SEO\Helpers\Open_Graph\Values_Helper;

[13] Fix | Delete

use Yoast\WP\SEO\Helpers\Options_Helper;

[14] Fix | Delete

use Yoast\WP\SEO\Helpers\Permalink_Helper;

[15] Fix | Delete

use Yoast\WP\SEO\Helpers\Url_Helper;

[16] Fix | Delete

use Yoast\WP\SEO\Helpers\User_Helper;

[17] Fix | Delete

use Yoast\WP\SEO\Models\Indexable;

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* Class Indexable_Presentation.

[21] Fix | Delete

[22] Fix | Delete

* Presentation object for indexables.

[23] Fix | Delete

[24] Fix | Delete

* @property string $title

[25] Fix | Delete

* @property string $meta_description

[26] Fix | Delete

* @property array $robots

[27] Fix | Delete

* @property string $canonical

[28] Fix | Delete

* @property string $rel_next

[29] Fix | Delete

* @property string $rel_prev

[30] Fix | Delete

* @property string $open_graph_type

[31] Fix | Delete

* @property string $open_graph_title

[32] Fix | Delete

* @property string $open_graph_description

[33] Fix | Delete

* @property array $open_graph_images

[34] Fix | Delete

* @property int $open_graph_image_id

[35] Fix | Delete

* @property string $open_graph_image

[36] Fix | Delete

* @property string $open_graph_url

[37] Fix | Delete

* @property string $open_graph_site_name

[38] Fix | Delete

* @property string $open_graph_article_publisher

[39] Fix | Delete

* @property string $open_graph_article_author

[40] Fix | Delete

* @property string $open_graph_article_published_time

[41] Fix | Delete

* @property string $open_graph_article_modified_time

[42] Fix | Delete

* @property string $open_graph_locale

[43] Fix | Delete

* @property string $open_graph_fb_app_id

[44] Fix | Delete

* @property string $permalink

[45] Fix | Delete

* @property array $schema

[46] Fix | Delete

* @property string $twitter_card

[47] Fix | Delete

* @property string $twitter_title

[48] Fix | Delete

* @property string $twitter_description

[49] Fix | Delete

* @property string $twitter_image

[50] Fix | Delete

* @property string $twitter_creator

[51] Fix | Delete

* @property string $twitter_site

[52] Fix | Delete

* @property object|array $source

[53] Fix | Delete

* @property array $breadcrumbs

[54] Fix | Delete

* @property int $estimated_reading_time_minutes

[55] Fix | Delete

* @property array $googlebot

[56] Fix | Delete

* @property array $bingbot

[57] Fix | Delete

[58] Fix | Delete

class Indexable_Presentation extends Abstract_Presentation {

[59] Fix | Delete

[60] Fix | Delete

/**

[61] Fix | Delete

* The indexable.

[62] Fix | Delete

[63] Fix | Delete

* @var Indexable

[64] Fix | Delete

[65] Fix | Delete

public $model;

[66] Fix | Delete

[67] Fix | Delete

/**

[68] Fix | Delete

* The meta tags context.

[69] Fix | Delete

[70] Fix | Delete

* @var Meta_Tags_Context

[71] Fix | Delete

[72] Fix | Delete

public $context;

[73] Fix | Delete

[74] Fix | Delete

/**

[75] Fix | Delete

* The Schema generator.

[76] Fix | Delete

[77] Fix | Delete

* @var Schema_Generator

[78] Fix | Delete

[79] Fix | Delete

protected $schema_generator;

[80] Fix | Delete

[81] Fix | Delete

/**

[82] Fix | Delete

* The Open Graph image generator.

[83] Fix | Delete

[84] Fix | Delete

* @var Open_Graph_Image_Generator

[85] Fix | Delete

[86] Fix | Delete

protected $open_graph_image_generator;

[87] Fix | Delete

[88] Fix | Delete

/**

[89] Fix | Delete

* The Twitter image generator.

[90] Fix | Delete

[91] Fix | Delete

* @var Twitter_Image_Generator

[92] Fix | Delete

[93] Fix | Delete

protected $twitter_image_generator;

[94] Fix | Delete

[95] Fix | Delete

/**

[96] Fix | Delete

* The Open Graph locale generator.

[97] Fix | Delete

[98] Fix | Delete

* @var Open_Graph_Locale_Generator

[99] Fix | Delete

[100] Fix | Delete

private $open_graph_locale_generator;

[101] Fix | Delete

[102] Fix | Delete

/**

[103] Fix | Delete

* The breadcrumbs generator.

[104] Fix | Delete

[105] Fix | Delete

* @var Breadcrumbs_Generator

[106] Fix | Delete

[107] Fix | Delete

private $breadcrumbs_generator;

[108] Fix | Delete

[109] Fix | Delete

/**

[110] Fix | Delete

* The current page helper.

[111] Fix | Delete

[112] Fix | Delete

* @var Current_Page_Helper

[113] Fix | Delete

[114] Fix | Delete

protected $current_page;

[115] Fix | Delete

[116] Fix | Delete

/**

[117] Fix | Delete

* The image helper.

[118] Fix | Delete

[119] Fix | Delete

* @var Image_Helper

[120] Fix | Delete

[121] Fix | Delete

protected $image;

[122] Fix | Delete

[123] Fix | Delete

/**

[124] Fix | Delete

* The options helper.

[125] Fix | Delete

[126] Fix | Delete

* @var Options_Helper

[127] Fix | Delete

[128] Fix | Delete

protected $options;

[129] Fix | Delete

[130] Fix | Delete

/**

[131] Fix | Delete

* The URL helper.

[132] Fix | Delete

[133] Fix | Delete

* @var Url_Helper

[134] Fix | Delete

[135] Fix | Delete

protected $url;

[136] Fix | Delete

[137] Fix | Delete

/**

[138] Fix | Delete

* The user helper.

[139] Fix | Delete

[140] Fix | Delete

* @var User_Helper

[141] Fix | Delete

[142] Fix | Delete

protected $user;

[143] Fix | Delete

[144] Fix | Delete

/**

[145] Fix | Delete

* The indexable helper.

[146] Fix | Delete

[147] Fix | Delete

* @var Indexable_Helper

[148] Fix | Delete

[149] Fix | Delete

protected $indexable_helper;

[150] Fix | Delete

[151] Fix | Delete

/**

[152] Fix | Delete

* The permalink helper.

[153] Fix | Delete

[154] Fix | Delete

* @var Permalink_Helper

[155] Fix | Delete

[156] Fix | Delete

protected $permalink_helper;

[157] Fix | Delete

[158] Fix | Delete

/**

[159] Fix | Delete

* The values helper.

[160] Fix | Delete

[161] Fix | Delete

* @var Values_Helper

[162] Fix | Delete

[163] Fix | Delete

protected $values_helper;

[164] Fix | Delete

[165] Fix | Delete

/**

[166] Fix | Delete

* Sets the generator dependencies.

[167] Fix | Delete

[168] Fix | Delete

* @required

[169] Fix | Delete

[170] Fix | Delete

* @param Schema_Generator $schema_generator The schema generator.

[171] Fix | Delete

* @param Open_Graph_Locale_Generator $open_graph_locale_generator The Open Graph locale generator.

[172] Fix | Delete

* @param Open_Graph_Image_Generator $open_graph_image_generator The Open Graph image generator.

[173] Fix | Delete

* @param Twitter_Image_Generator $twitter_image_generator The Twitter image generator.

[174] Fix | Delete

* @param Breadcrumbs_Generator $breadcrumbs_generator The breadcrumbs generator.

[175] Fix | Delete

[176] Fix | Delete

* @return void

[177] Fix | Delete

[178] Fix | Delete

public function set_generators(

[179] Fix | Delete

Schema_Generator $schema_generator,

[180] Fix | Delete

Open_Graph_Locale_Generator $open_graph_locale_generator,

[181] Fix | Delete

Open_Graph_Image_Generator $open_graph_image_generator,

[182] Fix | Delete

Twitter_Image_Generator $twitter_image_generator,

[183] Fix | Delete

Breadcrumbs_Generator $breadcrumbs_generator

[184] Fix | Delete

) {

[185] Fix | Delete

$this->schema_generator = $schema_generator;

[186] Fix | Delete

$this->open_graph_locale_generator = $open_graph_locale_generator;

[187] Fix | Delete

$this->open_graph_image_generator = $open_graph_image_generator;

[188] Fix | Delete

$this->twitter_image_generator = $twitter_image_generator;

[189] Fix | Delete

$this->breadcrumbs_generator = $breadcrumbs_generator;

[190] Fix | Delete

}

[191] Fix | Delete

[192] Fix | Delete

/**

[193] Fix | Delete

* Used by dependency injection container to inject the helpers.

[194] Fix | Delete

[195] Fix | Delete

* @required

[196] Fix | Delete

[197] Fix | Delete

* @param Image_Helper $image The image helper.

[198] Fix | Delete

* @param Options_Helper $options The options helper.

[199] Fix | Delete

* @param Current_Page_Helper $current_page The current page helper.

[200] Fix | Delete

* @param Url_Helper $url The URL helper.

[201] Fix | Delete

* @param User_Helper $user The user helper.

[202] Fix | Delete

* @param Indexable_Helper $indexable The indexable helper.

[203] Fix | Delete

* @param Permalink_Helper $permalink The permalink helper.

[204] Fix | Delete

* @param Values_Helper $values The values helper.

[205] Fix | Delete

[206] Fix | Delete

* @return void

[207] Fix | Delete

[208] Fix | Delete

public function set_helpers(

[209] Fix | Delete

Image_Helper $image,

[210] Fix | Delete

Options_Helper $options,

[211] Fix | Delete

Current_Page_Helper $current_page,

[212] Fix | Delete

Url_Helper $url,

[213] Fix | Delete

User_Helper $user,

[214] Fix | Delete

Indexable_Helper $indexable,

[215] Fix | Delete

Permalink_Helper $permalink,

[216] Fix | Delete

Values_Helper $values

[217] Fix | Delete

) {

[218] Fix | Delete

$this->image = $image;

[219] Fix | Delete

$this->options = $options;

[220] Fix | Delete

$this->current_page = $current_page;

[221] Fix | Delete

$this->url = $url;

[222] Fix | Delete

$this->user = $user;

[223] Fix | Delete

$this->indexable_helper = $indexable;

[224] Fix | Delete

$this->permalink_helper = $permalink;

[225] Fix | Delete

$this->values_helper = $values;

[226] Fix | Delete

}

[227] Fix | Delete

[228] Fix | Delete

/**

[229] Fix | Delete

* Gets the permalink from the indexable or generates it if dynamic permalinks are enabled.

[230] Fix | Delete

[231] Fix | Delete

* @return string The permalink.

[232] Fix | Delete

[233] Fix | Delete

public function generate_permalink() {

[234] Fix | Delete

if ( $this->indexable_helper->dynamic_permalinks_enabled() ) {

[235] Fix | Delete

return $this->permalink_helper->get_permalink_for_indexable( $this->model );

[236] Fix | Delete

}

[237] Fix | Delete

[238] Fix | Delete

if ( \is_date() ) {

[239] Fix | Delete

return $this->current_page->get_date_archive_permalink();

[240] Fix | Delete

}

[241] Fix | Delete

[242] Fix | Delete

if ( \is_attachment() ) {

[243] Fix | Delete

global $wp;

[244] Fix | Delete

return \trailingslashit( \home_url( $wp->request ) );

[245] Fix | Delete

}

[246] Fix | Delete

[247] Fix | Delete

return $this->model->permalink;

[248] Fix | Delete

}

[249] Fix | Delete

[250] Fix | Delete

/**

[251] Fix | Delete

* Generates the title.

[252] Fix | Delete

[253] Fix | Delete

* @return string The title.

[254] Fix | Delete

[255] Fix | Delete

public function generate_title() {

[256] Fix | Delete

if ( $this->model->title ) {

[257] Fix | Delete

return $this->model->title;

[258] Fix | Delete

}

[259] Fix | Delete

[260] Fix | Delete

return '';

[261] Fix | Delete

}

[262] Fix | Delete

[263] Fix | Delete

/**

[264] Fix | Delete

* Generates the meta description.

[265] Fix | Delete

[266] Fix | Delete

* @return string The meta description.

[267] Fix | Delete

[268] Fix | Delete

public function generate_meta_description() {

[269] Fix | Delete

if ( $this->model->description ) {

[270] Fix | Delete

return $this->model->description;

[271] Fix | Delete

}

[272] Fix | Delete

[273] Fix | Delete

return '';

[274] Fix | Delete

}

[275] Fix | Delete

[276] Fix | Delete

/**

[277] Fix | Delete

* Generates the robots value.

[278] Fix | Delete

[279] Fix | Delete

* @return array The robots value.

[280] Fix | Delete

[281] Fix | Delete

public function generate_robots() {

[282] Fix | Delete

$robots = $this->get_base_robots();

[283] Fix | Delete

[284] Fix | Delete

return $this->filter_robots( $robots );

[285] Fix | Delete

}

[286] Fix | Delete

[287] Fix | Delete

/**

[288] Fix | Delete

* Gets the base robots value.

[289] Fix | Delete

[290] Fix | Delete

* @return array The base robots value.

[291] Fix | Delete

[292] Fix | Delete

protected function get_base_robots() {

[293] Fix | Delete

return [

[294] Fix | Delete

'index' => ( $this->model->is_robots_noindex === true ) ? 'noindex' : 'index',

[295] Fix | Delete

'follow' => ( $this->model->is_robots_nofollow === true ) ? 'nofollow' : 'follow',

[296] Fix | Delete

'max-snippet' => 'max-snippet:-1',

[297] Fix | Delete

'max-image-preview' => 'max-image-preview:large',

[298] Fix | Delete

'max-video-preview' => 'max-video-preview:-1',

[299] Fix | Delete

];

[300] Fix | Delete

}

[301] Fix | Delete

[302] Fix | Delete

/**

[303] Fix | Delete

* Run the robots output content through the `wpseo_robots` filter.

[304] Fix | Delete

[305] Fix | Delete

* @param array $robots The meta robots values to filter.

[306] Fix | Delete

[307] Fix | Delete

* @return array The filtered meta robots values.

[308] Fix | Delete

[309] Fix | Delete

protected function filter_robots( $robots ) {

[310] Fix | Delete

// Remove values that are only listened to when indexing.

[311] Fix | Delete

if ( $robots['index'] === 'noindex' ) {

[312] Fix | Delete

$robots['imageindex'] = null;

[313] Fix | Delete

$robots['archive'] = null;

[314] Fix | Delete

$robots['snippet'] = null;

[315] Fix | Delete

$robots['max-snippet'] = null;

[316] Fix | Delete

$robots['max-image-preview'] = null;

[317] Fix | Delete

$robots['max-video-preview'] = null;

[318] Fix | Delete

}

[319] Fix | Delete

[320] Fix | Delete

$robots_string = \implode( ', ', \array_filter( $robots ) );

[321] Fix | Delete

[322] Fix | Delete

/**

[323] Fix | Delete

* Filter: 'wpseo_robots' - Allows filtering of the meta robots output of Yoast SEO.

[324] Fix | Delete

[325] Fix | Delete

* @param string $robots The meta robots directives to be echoed.

[326] Fix | Delete

* @param Indexable_Presentation $presentation The presentation of an indexable.

[327] Fix | Delete

[328] Fix | Delete

$robots_filtered = \apply_filters( 'wpseo_robots', $robots_string, $this );

[329] Fix | Delete

[330] Fix | Delete

// Convert the robots string back to an array.

[331] Fix | Delete

if ( \is_string( $robots_filtered ) ) {

[332] Fix | Delete

$robots_values = \explode( ', ', $robots_filtered );

[333] Fix | Delete

$robots_new = [];

[334] Fix | Delete

[335] Fix | Delete

foreach ( $robots_values as $value ) {

[336] Fix | Delete

$key = $value;

[337] Fix | Delete

[338] Fix | Delete

// Change `noindex` to `index.

[339] Fix | Delete

if ( \strpos( $key, 'no' ) === 0 ) {

[340] Fix | Delete

$key = \substr( $value, 2 );

[341] Fix | Delete

}

[342] Fix | Delete

// Change `max-snippet:-1` to `max-snippet`.

[343] Fix | Delete

$colon_position = \strpos( $key, ':' );

[344] Fix | Delete

if ( $colon_position !== false ) {

[345] Fix | Delete

$key = \substr( $value, 0, $colon_position );

[346] Fix | Delete

}

[347] Fix | Delete

[348] Fix | Delete

$robots_new[ $key ] = $value;

[349] Fix | Delete

}

[350] Fix | Delete

[351] Fix | Delete

$robots = $robots_new;

[352] Fix | Delete

}

[353] Fix | Delete

[354] Fix | Delete

if ( \is_bool( $robots_filtered ) && ( $robots_filtered === false ) ) {

[355] Fix | Delete

return [

[356] Fix | Delete

'index' => 'noindex',

[357] Fix | Delete

'follow' => 'nofollow',

[358] Fix | Delete

];

[359] Fix | Delete

}

[360] Fix | Delete

[361] Fix | Delete

if ( ! $robots_filtered ) {

[362] Fix | Delete

return [];

[363] Fix | Delete

}

[364] Fix | Delete

[365] Fix | Delete

/**

[366] Fix | Delete

* Filter: 'wpseo_robots_array' - Allows filtering of the meta robots output array of Yoast SEO.

[367] Fix | Delete

[368] Fix | Delete

* @param array $robots The meta robots directives to be used.

[369] Fix | Delete

* @param Indexable_Presentation $presentation The presentation of an indexable.

[370] Fix | Delete

[371] Fix | Delete

return \apply_filters( 'wpseo_robots_array', \array_filter( $robots ), $this );

[372] Fix | Delete

}

[373] Fix | Delete

[374] Fix | Delete

/**

[375] Fix | Delete

* Generates the canonical.

[376] Fix | Delete

[377] Fix | Delete

* @return string The canonical.

[378] Fix | Delete

[379] Fix | Delete

public function generate_canonical() {

[380] Fix | Delete

if ( $this->model->canonical ) {

[381] Fix | Delete

return $this->model->canonical;

[382] Fix | Delete

}

[383] Fix | Delete

[384] Fix | Delete

if ( $this->permalink ) {

[385] Fix | Delete

return $this->permalink;

[386] Fix | Delete

}

[387] Fix | Delete

[388] Fix | Delete

return '';

[389] Fix | Delete

}

[390] Fix | Delete

[391] Fix | Delete

/**

[392] Fix | Delete

* Generates the rel prev.

[393] Fix | Delete

[394] Fix | Delete

* @return string The rel prev value.

[395] Fix | Delete

[396] Fix | Delete

public function generate_rel_prev() {

[397] Fix | Delete

return '';

[398] Fix | Delete

}

[399] Fix | Delete

[400] Fix | Delete

/**

[401] Fix | Delete

* Generates the rel next.

[402] Fix | Delete

[403] Fix | Delete

* @return string The rel prev next.

[404] Fix | Delete

[405] Fix | Delete

public function generate_rel_next() {

[406] Fix | Delete

return '';

[407] Fix | Delete

}

[408] Fix | Delete

[409] Fix | Delete

/**

[410] Fix | Delete

* Generates the Open Graph type.

[411] Fix | Delete

[412] Fix | Delete

* @return string The Open Graph type.

[413] Fix | Delete

[414] Fix | Delete

public function generate_open_graph_type() {

[415] Fix | Delete

return 'website';

[416] Fix | Delete

}

[417] Fix | Delete

[418] Fix | Delete

/**

[419] Fix | Delete

* Generates the open graph title.

[420] Fix | Delete

[421] Fix | Delete

* @return string The open graph title.

[422] Fix | Delete

[423] Fix | Delete

public function generate_open_graph_title() {

[424] Fix | Delete

if ( $this->model->open_graph_title ) {

[425] Fix | Delete

$open_graph_title = $this->model->open_graph_title;

[426] Fix | Delete

}

[427] Fix | Delete

[428] Fix | Delete

if ( empty( $open_graph_title ) ) {

[429] Fix | Delete

// The helper applies a filter, but we don't have a default value at this stage so we pass an empty string.

[430] Fix | Delete

$open_graph_title = $this->values_helper->get_open_graph_title( '', $this->model->object_type, $this->model->object_sub_type );

[431] Fix | Delete

}

[432] Fix | Delete

[433] Fix | Delete

if ( empty( $open_graph_title ) ) {

[434] Fix | Delete

$open_graph_title = $this->title;

[435] Fix | Delete

}

[436] Fix | Delete

[437] Fix | Delete

return $open_graph_title;

[438] Fix | Delete

}

[439] Fix | Delete

[440] Fix | Delete

/**

[441] Fix | Delete

* Generates the open graph description.

[442] Fix | Delete

[443] Fix | Delete

* @return string The open graph description.

[444] Fix | Delete

[445] Fix | Delete

public function generate_open_graph_description() {

[446] Fix | Delete

if ( $this->model->open_graph_description ) {

[447] Fix | Delete

$open_graph_description = $this->model->open_graph_description;

[448] Fix | Delete

}

[449] Fix | Delete

[450] Fix | Delete

if ( empty( $open_graph_description ) ) {

[451] Fix | Delete

// The helper applies a filter, but we don't have a default value at this stage so we pass an empty string.

[452] Fix | Delete

$open_graph_description = $this->values_helper->get_open_graph_description( '', $this->model->object_type, $this->model->object_sub_type );

[453] Fix | Delete

}

[454] Fix | Delete

[455] Fix | Delete

if ( empty( $open_graph_description ) ) {

[456] Fix | Delete

$open_graph_description = $this->meta_description;

[457] Fix | Delete

}

[458] Fix | Delete

[459] Fix | Delete

return $open_graph_description;

[460] Fix | Delete

}

[461] Fix | Delete

[462] Fix | Delete

/**

[463] Fix | Delete

* Generates the open graph images.

[464] Fix | Delete

[465] Fix | Delete

* @return array The open graph images.

[466] Fix | Delete

[467] Fix | Delete

public function generate_open_graph_images() {

[468] Fix | Delete

if ( $this->context->open_graph_enabled === false ) {

[469] Fix | Delete

return [];

[470] Fix | Delete

}

[471] Fix | Delete

[472] Fix | Delete

return $this->open_graph_image_generator->generate( $this->context );

[473] Fix | Delete

}

[474] Fix | Delete

[475] Fix | Delete

/**

[476] Fix | Delete

* Generates the open graph image ID.

[477] Fix | Delete

[478] Fix | Delete

* @return string The open graph image ID.

[479] Fix | Delete

[480] Fix | Delete

public function generate_open_graph_image_id() {

[481] Fix | Delete

if ( $this->model->open_graph_image_id ) {

[482] Fix | Delete

return $this->model->open_graph_image_id;

[483] Fix | Delete

}

[484] Fix | Delete

[485] Fix | Delete

return $this->values_helper->get_open_graph_image_id( 0, $this->model->object_type, $this->model->object_sub_type );

[486] Fix | Delete

}

[487] Fix | Delete

[488] Fix | Delete

/**

[489] Fix | Delete

* Generates the open graph image URL.

[490] Fix | Delete

[491] Fix | Delete

* @return string The open graph image URL.

[492] Fix | Delete

[493] Fix | Delete

public function generate_open_graph_image() {

[494] Fix | Delete

if ( $this->model->open_graph_image ) {

[495] Fix | Delete

return $this->model->open_graph_image;

[496] Fix | Delete

}

[497] Fix | Delete

[498] Fix | Delete

return $this->values_helper->get_open_graph_image( '', $this->model->object_type, $this->model->object_sub_type );

[499] Fix | Delete