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

Parse.ly, version 3.20.2. 132 lines.

- Page: https://pluginprobe.com/plugins/wp-parsely/3.20.2/code/src/Endpoints/class-rest-metadata.php
- Raw: https://pluginprobe.com/plugins/wp-parsely/3.20.2/raw/src/Endpoints/class-rest-metadata.php
- Modified: 2025-05-20T15:11:42+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/wp-parsely/3.20.2/code/src/Endpoints/class-rest-metadata.php#L10-L20`.

```php
<?php
/**
 * Endpoints: REST Metadata endpoint class
 *
 * @package Parsely
 * @since   3.1.0
 */

declare(strict_types=1);

namespace Parsely\Endpoints;

use Parsely\Metadata;
use WP_Post;
use Parsely\Models\Smart_Link;
use Parsely\Models\Smart_Link_Status;
use Parsely\Models\Inbound_Smart_Link;

/**
 * Injects Parse.ly Metadata to WordPress REST API.
 *
 * @since 3.1.0
 * @since 3.2.0 Renamed FQCN from `Parsely\Rest` to `Parsely\Endpoints\Rest_Metadata`.
 */
class Rest_Metadata extends Metadata_Endpoint {
	private const REST_VERSION = '1.1.0';

	/**
	 * Registers fields in WordPress REST API.
	 *
	 * @since 3.1.0
	 */
	public function run(): void {
		if ( apply_filters( 'wp_parsely_enable_rest_api_support', true ) && $this->parsely->site_id_is_set() ) {
			$this->register_meta();
		}
	}

	/**
	 * Registers the meta field on the appropriate resource types in the REST API.
	 *
	 * @since 3.1.0
	 */
	public function register_meta(): void {
		$object_types = $this->parsely->get_all_track_types();

		/**
		 * Filters the list of object types that the Parse.ly REST API is hooked into.
		 *
		 * @since 3.1.0
		 *
		 * @param string[] $object_types Array of strings containing the object types, i.e. `page`,
		 *                 `post`, `term`.
		 */
		$object_types = apply_filters( 'wp_parsely_rest_object_types', $object_types );

		$args = array( 'get_callback' => array( $this, 'get_callback' ) );
		register_rest_field( $object_types, self::FIELD_NAME, $args );
	}

	/**
	 * Function to get hooked into the `get_callback` property of the `parsely`
	 * REST API field. It generates the `parsely` object in the REST API.
	 *
	 * @since 3.1.0
	 * @since 3.19.0 Added the `canonical_url` field.
	 *
	 * @param array<string, mixed> $object_data The data of the object to render the metadata for,
	 *                                          usually a post or a page.
	 * @return array<string, mixed> The `parsely` object to be rendered in the REST API. Contains a
	 *                              version number describing the response and the `meta` object
	 *                              containing the actual metadata.
	 */
	public function get_callback( array $object_data ): array {
		/** @var int $post_id */
		$post_id = $object_data['ID'] ?? $object_data['id'] ?? 0;
		$post    = WP_Post::get_instance( $post_id );

		$options = $this->parsely->get_options();

		$response = array(
			'version'                         => self::REST_VERSION,
			'canonical_url'                   => \Parsely\Parsely::get_canonical_url_from_post( $post_id ),
			'smart_links'                     => array(
				'inbound'  => 0,
				'outbound' => 0,
			),
			'traffic_boost_suggestions_count' => 0,
		);

		if ( false === $post ) {
			return $response;
		}

		$metadata         = ( new Metadata( $this->parsely ) )->construct_metadata( $post );
		$response['meta'] = $metadata;

		/**
		 * Filter whether REST API support in rendered string format is enabled
		 * or not.
		 *
		 * @since 3.1.0
		 *
		 * @param bool $enabled True if enabled, false if not.
		 * @param WP_Post|false $post Current post object.
		 */
		if ( apply_filters( 'wp_parsely_enable_rest_rendered_support', true, $post ) ) {
			$response['rendered'] = $this->get_rendered_meta( $options['meta_type'] );
		}

		/**
		 * Filter whether the REST API returns the tracker URL.
		 *
		 * @since 3.3.0
		 *
		 * @param bool $enabled True if enabled, false if not.
		 * @param WP_Post|false $post Current post object.
		 */
		if ( apply_filters( 'wp_parsely_enable_tracker_url', true, $post ) ) {
			$response['tracker_url'] = $this->parsely->get_tracker_url();
		}

		// Fetch Smart Link data.
		$response['smart_links'] = Smart_Link::get_link_counts( $post_id, Smart_Link_Status::APPLIED );

		// Fetch Traffic Boost data.
		$response['traffic_boost_suggestions_count'] = Inbound_Smart_Link::get_suggestions_count( $post_id );

		return $response;
	}
}

```