Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WP\SEO\Generators\Schema;

[2] Fix | Delete

[3] Fix | Delete

use WP_Post;

[4] Fix | Delete

use Yoast\WP\SEO\Config\Schema_IDs;

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Returns schema WebPage data.

[8] Fix | Delete

[9] Fix | Delete

class WebPage extends Abstract_Schema_Piece {

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* Determines whether or not a piece should be added to the graph.

[13] Fix | Delete

[14] Fix | Delete

* @return bool

[15] Fix | Delete

[16] Fix | Delete

public function is_needed() {

[17] Fix | Delete

if ( $this->context->indexable->object_type === 'unknown' ) {

[18] Fix | Delete

return false;

[19] Fix | Delete

}

[20] Fix | Delete

return ! ( $this->context->indexable->object_type === 'system-page' && $this->context->indexable->object_sub_type === '404' );

[21] Fix | Delete

}

[22] Fix | Delete

[23] Fix | Delete

/**

[24] Fix | Delete

* Returns WebPage schema data.

[25] Fix | Delete

[26] Fix | Delete

* @return array<string|array<string>> WebPage schema data.

[27] Fix | Delete

[28] Fix | Delete

public function generate() {

[29] Fix | Delete

$data = [

[30] Fix | Delete

'@type' => $this->context->schema_page_type,

[31] Fix | Delete

'@id' => $this->context->main_schema_id,

[32] Fix | Delete

'url' => $this->context->canonical,

[33] Fix | Delete

'name' => $this->helpers->schema->html->smart_strip_tags( $this->context->title ),

[34] Fix | Delete

'isPartOf' => [

[35] Fix | Delete

'@id' => $this->context->site_url . Schema_IDs::WEBSITE_HASH,

[36] Fix | Delete

[37] Fix | Delete

];

[38] Fix | Delete

[39] Fix | Delete

if ( empty( $this->context->canonical ) && \is_search() ) {

[40] Fix | Delete

$data['url'] = $this->build_search_url();

[41] Fix | Delete

}

[42] Fix | Delete

[43] Fix | Delete

if ( $this->helpers->current_page->is_front_page() ) {

[44] Fix | Delete

if ( $this->context->site_represents_reference ) {

[45] Fix | Delete

$data['about'] = $this->context->site_represents_reference;

[46] Fix | Delete

}

[47] Fix | Delete

}

[48] Fix | Delete

[49] Fix | Delete

$data = $this->add_image( $data );

[50] Fix | Delete

[51] Fix | Delete

if ( $this->context->indexable->object_type === 'post' ) {

[52] Fix | Delete

$data['datePublished'] = $this->helpers->date->format( $this->context->post->post_date_gmt );

[53] Fix | Delete

$data['dateModified'] = $this->helpers->date->format( $this->context->post->post_modified_gmt );

[54] Fix | Delete

[55] Fix | Delete

if ( $this->context->indexable->object_sub_type === 'post' ) {

[56] Fix | Delete

$data = $this->add_author( $data, $this->context->post );

[57] Fix | Delete

}

[58] Fix | Delete

}

[59] Fix | Delete

[60] Fix | Delete

if ( ! empty( $this->context->description ) ) {

[61] Fix | Delete

$data['description'] = $this->helpers->schema->html->smart_strip_tags( $this->context->description );

[62] Fix | Delete

}

[63] Fix | Delete

[64] Fix | Delete

if ( $this->add_breadcrumbs() ) {

[65] Fix | Delete

$data['breadcrumb'] = [

[66] Fix | Delete

'@id' => $this->context->canonical . Schema_IDs::BREADCRUMB_HASH,

[67] Fix | Delete

];

[68] Fix | Delete

}

[69] Fix | Delete

[70] Fix | Delete

if ( ! empty( $this->context->main_entity_of_page ) ) {

[71] Fix | Delete

$data['mainEntity'] = $this->context->main_entity_of_page;

[72] Fix | Delete

}

[73] Fix | Delete

[74] Fix | Delete

$data = $this->helpers->schema->language->add_piece_language( $data );

[75] Fix | Delete

$data = $this->add_potential_action( $data );

[76] Fix | Delete

[77] Fix | Delete

return $data;

[78] Fix | Delete

}

[79] Fix | Delete

[80] Fix | Delete

/**

[81] Fix | Delete

* Adds an author property to the $data if the WebPage is not represented.

[82] Fix | Delete

[83] Fix | Delete

* @param array<string|array<string>> $data The WebPage schema.

[84] Fix | Delete

* @param WP_Post $post The post the context is representing.

[85] Fix | Delete

[86] Fix | Delete

* @return array<string|array<string>> The WebPage schema.

[87] Fix | Delete

[88] Fix | Delete

public function add_author( $data, $post ) {

[89] Fix | Delete

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

[90] Fix | Delete

$data['author'] = [ '@id' => $this->helpers->schema->id->get_user_schema_id( $post->post_author, $this->context ) ];

[91] Fix | Delete

}

[92] Fix | Delete

[93] Fix | Delete

return $data;

[94] Fix | Delete

}

[95] Fix | Delete

[96] Fix | Delete

/**

[97] Fix | Delete

* If we have an image, make it the primary image of the page.

[98] Fix | Delete

[99] Fix | Delete

* @param array<string|array<string>> $data WebPage schema data.

[100] Fix | Delete

[101] Fix | Delete

* @return array<string|array<string>>

[102] Fix | Delete

[103] Fix | Delete

public function add_image( $data ) {

[104] Fix | Delete

if ( $this->context->has_image ) {

[105] Fix | Delete

$data['primaryImageOfPage'] = [ '@id' => $this->context->canonical . Schema_IDs::PRIMARY_IMAGE_HASH ];

[106] Fix | Delete

$data['image'] = [ '@id' => $this->context->canonical . Schema_IDs::PRIMARY_IMAGE_HASH ];

[107] Fix | Delete

$data['thumbnailUrl'] = $this->context->main_image_url;

[108] Fix | Delete

}

[109] Fix | Delete

return $data;

[110] Fix | Delete

}

[111] Fix | Delete

[112] Fix | Delete

/**

[113] Fix | Delete

* Determine if we should add a breadcrumb attribute.

[114] Fix | Delete

[115] Fix | Delete

* @return bool

[116] Fix | Delete

[117] Fix | Delete

private function add_breadcrumbs() {

[118] Fix | Delete

if ( $this->context->indexable->object_type === 'system-page' && $this->context->indexable->object_sub_type === '404' ) {

[119] Fix | Delete

return false;

[120] Fix | Delete

}

[121] Fix | Delete

[122] Fix | Delete

return true;

[123] Fix | Delete

}

[124] Fix | Delete

[125] Fix | Delete

/**

[126] Fix | Delete

* Adds the potential action property to the WebPage Schema piece.

[127] Fix | Delete

[128] Fix | Delete

* @param array<string|array<string>> $data The WebPage data.

[129] Fix | Delete

[130] Fix | Delete

* @return array<string|array<string>> The WebPage data with the potential action added.

[131] Fix | Delete

[132] Fix | Delete

private function add_potential_action( $data ) {

[133] Fix | Delete

$url = $this->context->canonical;

[134] Fix | Delete

if ( $data['@type'] === 'CollectionPage' || ( \is_array( $data['@type'] ) && \in_array( 'CollectionPage', $data['@type'], true ) ) ) {

[135] Fix | Delete

return $data;

[136] Fix | Delete

}

[137] Fix | Delete

[138] Fix | Delete

/**

[139] Fix | Delete

* Filter: 'wpseo_schema_webpage_potential_action_target' - Allows filtering of the schema WebPage potentialAction target.

[140] Fix | Delete

[141] Fix | Delete

* @param array<string> $targets The URLs for the WebPage potentialAction target.

[142] Fix | Delete

[143] Fix | Delete

$targets = \apply_filters( 'wpseo_schema_webpage_potential_action_target', [ $url ] );

[144] Fix | Delete

[145] Fix | Delete

$data['potentialAction'][] = [

[146] Fix | Delete

'@type' => 'ReadAction',

[147] Fix | Delete

'target' => $targets,

[148] Fix | Delete

];

[149] Fix | Delete

[150] Fix | Delete

return $data;

[151] Fix | Delete

}

[152] Fix | Delete

[153] Fix | Delete

/**

[154] Fix | Delete

* Creates the search URL for use when if there is no canonical.

[155] Fix | Delete

[156] Fix | Delete

* @return string Search URL.

[157] Fix | Delete

[158] Fix | Delete

private function build_search_url() {

[159] Fix | Delete

return $this->context->site_url . '?s=' . \rawurlencode( \get_search_query() );

[160] Fix | Delete

}

[161] Fix | Delete

}

[162] Fix | Delete

[163] Fix | Delete