wp-parsely / src / Endpoints / class-rest-metadata.php

class-rest-metadata.php in Parse.ly 3.24.2, at src/Endpoints/class-rest-metadata.php

119 lines 3.4 KB

Raw Download Zip

1	<?php
2	/**
3	* Endpoints: REST Metadata endpoint class
4	*
5	* @package Parsely
6	* @since 3.1.0
7	*/
8
9	declare(strict_types=1);
10
11	namespace Parsely\Endpoints;
12
13	use Parsely\Metadata;
14	use WP_Post;
15
16	/**
17	* Injects Parse.ly Metadata to WordPress REST API.
18	*
19	* @since 3.1.0
20	* @since 3.2.0 Renamed FQCN from `Parsely\Rest` to `Parsely\Endpoints\Rest_Metadata`.
21	*/
22	class Rest_Metadata extends Metadata_Endpoint {
23	private const REST_VERSION = '1.1.0';
24
25	/**
26	* Registers fields in WordPress REST API.
27	*
28	* @since 3.1.0
29	*/
30	public function run(): void {
31	if ( apply_filters( 'wp_parsely_enable_rest_api_support', true ) && $this->parsely->site_id_is_set() ) {
32	$this->register_meta();
33	}
34	}
35
36	/**
37	* Registers the meta field on the appropriate resource types in the REST API.
38	*
39	* @since 3.1.0
40	*/
41	public function register_meta(): void {
42	$object_types = $this->parsely->get_all_track_types();
43
44	/**
45	* Filters the list of object types that the Parse.ly REST API is hooked into.
46	*
47	* @since 3.1.0
48	*
49	* @param string[] $object_types Array of strings containing the object types, i.e. `page`,
50	* `post`, `term`.
51	*/
52	$object_types = apply_filters( 'wp_parsely_rest_object_types', $object_types );
53
54	$args = array( 'get_callback' => array( $this, 'get_callback' ) );
55	register_rest_field( $object_types, self::FIELD_NAME, $args );
56	}
57
58	/**
59	* Function to get hooked into the `get_callback` property of the `parsely`
60	* REST API field. It generates the `parsely` object in the REST API.
61	*
62	* @since 3.1.0
63	* @since 3.19.0 Added the `canonical_url` field.
64	* @since 3.24.2 Removed the `smart_links` and `traffic_boost_suggestions_count` fields.
65	*
66	* @param array<string, mixed> $object_data The data of the object to render the metadata for,
67	* usually a post or a page.
68	* @return array<string, mixed> The `parsely` object to be rendered in the REST API. Contains a
69	* version number describing the response and the `meta` object
70	* containing the actual metadata.
71	*/
72	public function get_callback( array $object_data ): array {
73	/** @var int $post_id */
74	$post_id = $object_data['ID'] ?? $object_data['id'] ?? 0;
75	$post = WP_Post::get_instance( $post_id );
76
77	$options = $this->parsely->get_options();
78
79	$response = array(
80	'version' => self::REST_VERSION,
81	'canonical_url' => \Parsely\Parsely::get_canonical_url_from_post( $post_id ),
82	);
83
84	if ( false === $post ) {
85	return $response;
86	}
87
88	$metadata = ( new Metadata( $this->parsely ) )->construct_metadata( $post );
89	$response['meta'] = $metadata;
90
91	/**
92	* Filter whether REST API support in rendered string format is enabled
93	* or not.
94	*
95	* @since 3.1.0
96	*
97	* @param bool $enabled True if enabled, false if not.
98	* @param WP_Post\|false $post Current post object.
99	*/
100	if ( apply_filters( 'wp_parsely_enable_rest_rendered_support', true, $post ) ) {
101	$response['rendered'] = $this->get_rendered_meta( $options['meta_type'] );
102	}
103
104	/**
105	* Filter whether the REST API returns the tracker URL.
106	*
107	* @since 3.3.0
108	*
109	* @param bool $enabled True if enabled, false if not.
110	* @param WP_Post\|false $post Current post object.
111	*/
112	if ( apply_filters( 'wp_parsely_enable_tracker_url', true, $post ) ) {
113	$response['tracker_url'] = $this->parsely->get_tracker_url();
114	}
115
116	return $response;
117	}
118	}
119