Edit File by line

<?php // phpcs:ignore Yoast.Files.FileName.InvalidClassFileName -- Reason: this explicitly concerns the Yoast head fields.

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WP\SEO\Routes;

[2] Fix | Delete

[3] Fix | Delete

use Yoast\WP\SEO\Actions\Indexables\Indexable_Head_Action;

[4] Fix | Delete

use Yoast\WP\SEO\Conditionals\Headless_Rest_Endpoints_Enabled_Conditional;

[5] Fix | Delete

use Yoast\WP\SEO\Helpers\Post_Helper;

[6] Fix | Delete

use Yoast\WP\SEO\Helpers\Post_Type_Helper;

[7] Fix | Delete

use Yoast\WP\SEO\Helpers\Taxonomy_Helper;

[8] Fix | Delete

[9] Fix | Delete

/**

[10] Fix | Delete

* Yoast_Head_REST_Field class.

[11] Fix | Delete

[12] Fix | Delete

* Registers the yoast head REST field.

[13] Fix | Delete

* Not technically a route but behaves the same so is included here.

[14] Fix | Delete

[15] Fix | Delete

class Yoast_Head_REST_Field implements Route_Interface {

[16] Fix | Delete

[17] Fix | Delete

/**

[18] Fix | Delete

* The name of the Yoast head field.

[19] Fix | Delete

[20] Fix | Delete

* @var string

[21] Fix | Delete

[22] Fix | Delete

public const YOAST_HEAD_ATTRIBUTE_NAME = 'yoast_head';

[23] Fix | Delete

[24] Fix | Delete

/**

[25] Fix | Delete

* The name of the Yoast head JSON field.

[26] Fix | Delete

[27] Fix | Delete

* @var string

[28] Fix | Delete

[29] Fix | Delete

public const YOAST_JSON_HEAD_ATTRIBUTE_NAME = 'yoast_head_json';

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* The post type helper.

[33] Fix | Delete

[34] Fix | Delete

* @var Post_Type_Helper

[35] Fix | Delete

[36] Fix | Delete

protected $post_type_helper;

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* The taxonomy helper.

[40] Fix | Delete

[41] Fix | Delete

* @var Taxonomy_Helper

[42] Fix | Delete

[43] Fix | Delete

protected $taxonomy_helper;

[44] Fix | Delete

[45] Fix | Delete

/**

[46] Fix | Delete

* The post helper.

[47] Fix | Delete

[48] Fix | Delete

* @var Post_Helper

[49] Fix | Delete

[50] Fix | Delete

protected $post_helper;

[51] Fix | Delete

[52] Fix | Delete

/**

[53] Fix | Delete

* The head action.

[54] Fix | Delete

[55] Fix | Delete

* @var Indexable_Head_Action

[56] Fix | Delete

[57] Fix | Delete

protected $head_action;

[58] Fix | Delete

[59] Fix | Delete

/**

[60] Fix | Delete

* Returns the conditionals based in which this loadable should be active.

[61] Fix | Delete

[62] Fix | Delete

* @return array

[63] Fix | Delete

[64] Fix | Delete

public static function get_conditionals() {

[65] Fix | Delete

return [ Headless_Rest_Endpoints_Enabled_Conditional::class ];

[66] Fix | Delete

}

[67] Fix | Delete

[68] Fix | Delete

/**

[69] Fix | Delete

* Yoast_Head_REST_Field constructor.

[70] Fix | Delete

[71] Fix | Delete

* @param Post_Type_Helper $post_type_helper The post type helper.

[72] Fix | Delete

* @param Taxonomy_Helper $taxonomy_helper The taxonomy helper.

[73] Fix | Delete

* @param Post_Helper $post_helper The post helper.

[74] Fix | Delete

* @param Indexable_Head_Action $head_action The head action.

[75] Fix | Delete

[76] Fix | Delete

public function __construct(

[77] Fix | Delete

Post_Type_Helper $post_type_helper,

[78] Fix | Delete

Taxonomy_Helper $taxonomy_helper,

[79] Fix | Delete

Post_Helper $post_helper,

[80] Fix | Delete

Indexable_Head_Action $head_action

[81] Fix | Delete

) {

[82] Fix | Delete

$this->post_type_helper = $post_type_helper;

[83] Fix | Delete

$this->taxonomy_helper = $taxonomy_helper;

[84] Fix | Delete

$this->post_helper = $post_helper;

[85] Fix | Delete

$this->head_action = $head_action;

[86] Fix | Delete

}

[87] Fix | Delete

[88] Fix | Delete

/**

[89] Fix | Delete

* Registers routes with WordPress.

[90] Fix | Delete

[91] Fix | Delete

* @return void

[92] Fix | Delete

[93] Fix | Delete

public function register_routes() {

[94] Fix | Delete

$public_post_types = $this->post_type_helper->get_indexable_post_types();

[95] Fix | Delete

[96] Fix | Delete

foreach ( $public_post_types as $post_type ) {

[97] Fix | Delete

$this->register_rest_fields( $post_type, 'for_post' );

[98] Fix | Delete

}

[99] Fix | Delete

[100] Fix | Delete

$public_taxonomies = $this->taxonomy_helper->get_indexable_taxonomies();

[101] Fix | Delete

[102] Fix | Delete

foreach ( $public_taxonomies as $taxonomy ) {

[103] Fix | Delete

if ( $taxonomy === 'post_tag' ) {

[104] Fix | Delete

$taxonomy = 'tag';

[105] Fix | Delete

}

[106] Fix | Delete

$this->register_rest_fields( $taxonomy, 'for_term' );

[107] Fix | Delete

}

[108] Fix | Delete

[109] Fix | Delete

$this->register_rest_fields( 'user', 'for_author' );

[110] Fix | Delete

$this->register_rest_fields( 'type', 'for_post_type_archive' );

[111] Fix | Delete

}

[112] Fix | Delete

[113] Fix | Delete

/**

[114] Fix | Delete

* Returns the head for a post.

[115] Fix | Delete

[116] Fix | Delete

* @param array $params The rest request params.

[117] Fix | Delete

* @param string $format The desired output format.

[118] Fix | Delete

[119] Fix | Delete

* @return string|null The head.

[120] Fix | Delete

[121] Fix | Delete

public function for_post( $params, $format = self::YOAST_HEAD_ATTRIBUTE_NAME ) {

[122] Fix | Delete

if ( ! isset( $params['id'] ) ) {

[123] Fix | Delete

return null;

[124] Fix | Delete

}

[125] Fix | Delete

[126] Fix | Delete

if ( ! $this->post_helper->is_post_indexable( $params['id'] ) ) {

[127] Fix | Delete

return null;

[128] Fix | Delete

}

[129] Fix | Delete

$obj = $this->head_action->for_post( $params['id'] );

[130] Fix | Delete

[131] Fix | Delete

return $this->render_object( $obj, $format );

[132] Fix | Delete

}

[133] Fix | Delete

[134] Fix | Delete

/**

[135] Fix | Delete

* Returns the head for a term.

[136] Fix | Delete

[137] Fix | Delete

* @param array $params The rest request params.

[138] Fix | Delete

* @param string $format The desired output format.

[139] Fix | Delete

[140] Fix | Delete

* @return string|null The head.

[141] Fix | Delete

[142] Fix | Delete

public function for_term( $params, $format = self::YOAST_HEAD_ATTRIBUTE_NAME ) {

[143] Fix | Delete

$obj = $this->head_action->for_term( $params['id'] );

[144] Fix | Delete

[145] Fix | Delete

return $this->render_object( $obj, $format );

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete

/**

[149] Fix | Delete

* Returns the head for an author.

[150] Fix | Delete

[151] Fix | Delete

* @param array $params The rest request params.

[152] Fix | Delete

* @param string $format The desired output format.

[153] Fix | Delete

[154] Fix | Delete

* @return string|null The head.

[155] Fix | Delete

[156] Fix | Delete

public function for_author( $params, $format = self::YOAST_HEAD_ATTRIBUTE_NAME ) {

[157] Fix | Delete

$obj = $this->head_action->for_author( $params['id'] );

[158] Fix | Delete

[159] Fix | Delete

return $this->render_object( $obj, $format );

[160] Fix | Delete

}

[161] Fix | Delete

[162] Fix | Delete

/**

[163] Fix | Delete

* Returns the head for a post type archive.

[164] Fix | Delete

[165] Fix | Delete

* @param array $params The rest request params.

[166] Fix | Delete

* @param string $format The desired output format.

[167] Fix | Delete

[168] Fix | Delete

* @return string|null The head.

[169] Fix | Delete

[170] Fix | Delete

public function for_post_type_archive( $params, $format = self::YOAST_HEAD_ATTRIBUTE_NAME ) {

[171] Fix | Delete

if ( $params['slug'] === 'post' ) {

[172] Fix | Delete

$obj = $this->head_action->for_posts_page();

[173] Fix | Delete

}

[174] Fix | Delete

elseif ( ! $this->post_type_helper->has_archive( $params['slug'] ) ) {

[175] Fix | Delete

return null;

[176] Fix | Delete

}

[177] Fix | Delete

else {

[178] Fix | Delete

$obj = $this->head_action->for_post_type_archive( $params['slug'] );

[179] Fix | Delete

}

[180] Fix | Delete

[181] Fix | Delete

return $this->render_object( $obj, $format );

[182] Fix | Delete

}

[183] Fix | Delete

[184] Fix | Delete

/**

[185] Fix | Delete

* Registers the Yoast rest fields.

[186] Fix | Delete

[187] Fix | Delete

* @param string $object_type The object type.

[188] Fix | Delete

* @param string $callback The function name of the callback.

[189] Fix | Delete

[190] Fix | Delete

* @return void

[191] Fix | Delete

[192] Fix | Delete

protected function register_rest_fields( $object_type, $callback ) {

[193] Fix | Delete

// Output metadata in page head meta tags.

[194] Fix | Delete

\register_rest_field( $object_type, self::YOAST_HEAD_ATTRIBUTE_NAME, [ 'get_callback' => [ $this, $callback ] ] );

[195] Fix | Delete

// Output metadata in a json object in a head meta tag.

[196] Fix | Delete

\register_rest_field( $object_type, self::YOAST_JSON_HEAD_ATTRIBUTE_NAME, [ 'get_callback' => [ $this, $callback ] ] );

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

/**

[200] Fix | Delete

* Returns the correct property for the Yoast head.

[201] Fix | Delete

[202] Fix | Delete

* @param stdObject $head The Yoast head.

[203] Fix | Delete

* @param string $format The format to return.

[204] Fix | Delete

[205] Fix | Delete

* @return string|array|null The output value. String if HTML was requested, array otherwise.

[206] Fix | Delete

[207] Fix | Delete

protected function render_object( $head, $format = self::YOAST_HEAD_ATTRIBUTE_NAME ) {

[208] Fix | Delete

if ( $head->status === 404 ) {

[209] Fix | Delete

return null;

[210] Fix | Delete

}

[211] Fix | Delete

[212] Fix | Delete

switch ( $format ) {

[213] Fix | Delete

case self::YOAST_HEAD_ATTRIBUTE_NAME:

[214] Fix | Delete

return $head->html;

[215] Fix | Delete

case self::YOAST_JSON_HEAD_ATTRIBUTE_NAME:

[216] Fix | Delete

return $head->json;

[217] Fix | Delete

}

[218] Fix | Delete

[219] Fix | Delete

return null;

[220] Fix | Delete

}

[221] Fix | Delete

}

[222] Fix | Delete

[223] Fix | Delete