insideout10 / wordlift-plugin

src/public/class-wordlift-term-jsonld-adapter.php

Indentation +378 added lines, -378 removed lines

@@ -22,382 +22,382 @@
  */
 class Wordlift_Term_JsonLd_Adapter {
 
-	/**
-	 * The {@link Wordlift_Entity_Uri_Service} instance.
-	 *
-	 * @since 3.20.0
-	 * @access private
-	 * @var \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
-	 */
-	private $entity_uri_service;
-
-	/**
-	 * Instance.
-	 *
-	 * @var Wordlift_Term_JsonLd_Adapter
-	 */
-	private static $instance;
-
-	/**
-	 * @var Wordlift_Post_Converter
-	 */
-	private $post_id_to_jsonld_converter;
-
-	/**
-	 * The {@link Api_Service} used to communicate with the remote APIs.
-	 *
-	 * @access private
-	 * @var Default_Api_Service
-	 */
-	private $api_service;
-
-	/**
-	 * Wordlift_Term_JsonLd_Adapter constructor.
-	 *
-	 * @param \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
-	 * @param \Wordlift_Post_Converter     $post_id_to_jsonld_converter The {@link Wordlift_Post_Converter} instance.
-	 *
-	 * @since 3.20.0
-	 */
-	public function __construct( $entity_uri_service, $post_id_to_jsonld_converter ) {
-
-		add_action( 'wp_head', array( $this, 'wp_head' ) );
-
-		$this->api_service                 = Default_Api_Service::get_instance();
-		$this->entity_uri_service          = $entity_uri_service;
-		$this->post_id_to_jsonld_converter = $post_id_to_jsonld_converter;
-
-		self::$instance = $this;
-	}
-
-	/**
-	 * Get instance.
-	 *
-	 * @return Wordlift_Term_JsonLd_Adapter|static
-	 */
-	public static function get_instance() {
-		return self::$instance;
-	}
-
-	/**
-	 * Adds carousel json ld data to term page if the conditions match
-	 *
-	 * @return array|boolean
-	 */
-	public function get_carousel_jsonld( $id = null ) {
-		$posts       = $this->get_posts( $id );
-		$post_jsonld = array();
-		if ( ! is_array( $posts ) || count( $posts ) < 2 ) {
-			// Bail out if no posts are present.
-			return false;
-		}
-
-		if ( $id !== null ) {
-			$term                       = get_term( $id );
-			$post_jsonld['description'] = wp_strip_all_tags( strip_shortcodes( $term->description ) );
-			$thumbnail_id               = get_term_meta( $id, 'thumbnail_id', true );
-			if ( ! empty( $thumbnail_id ) ) {
-				$post_jsonld['image'] = wp_get_attachment_url( $thumbnail_id );
-			}
-		}
-
-		// More than 2 items are present, so construct the post_jsonld data
-		$post_jsonld['@context']        = 'https://schema.org';
-		$post_jsonld['@type']           = 'ItemList';
-		$post_jsonld['url']             = $this->get_term_url( $id );
-		$post_jsonld['itemListElement'] = array();
-		$position                       = 1;
-
-		foreach ( $posts as $post_id ) {
-			$result = array(
-				'@type'    => 'ListItem',
-				'position' => $position,
-				/**
-				 * We can't use `item` here unless we change the URL for the item to point to the current page.
-				 *
-				 * See https://developers.google.com/search/docs/data-types/carousel
-				 */
-				'url'      => apply_filters( 'wl_carousel_post_list_item_url', get_permalink( $post_id ), $post_id ),
-			);
-			array_push( $post_jsonld['itemListElement'], $result );
-			++ $position;
-		}
-
-		return $post_jsonld;
-	}
-
-	/**
-	 * Get posts.
-	 *
-	 * @param $id
-	 *
-	 * @return array|int[]|string[]|WP_Error|null
-	 */
-	private function get_posts( $id ) {
-		global $wp_query;
-
-		if ( $wp_query->posts !== null ) {
-			return array_map(
-				function ( $post ) {
-					return $post->ID;
-				},
-				$wp_query->posts
-			);
-		}
-
-		if ( $id === null ) {
-			return null;
-		}
-
-		$term = get_term( $id );
-
-		return get_objects_in_term( $id, $term->taxonomy );
-	}
-
-	/**
-	 * Hook to `wp_head` to print the JSON-LD.
-	 *
-	 * @since 3.20.0
-	 */
-	public function wp_head() {
-		$query_object = get_queried_object();
-
-		// Check if it is a term page.
-		if ( ! $query_object instanceof WP_Term ) {
-			return;
-		}
-
-		// Bail out if `wl_jsonld_enabled` isn't enabled.
-		if ( ! apply_filters( 'wl_jsonld_enabled', true ) ) {
-			return;
-		}
-
-		$term_id = $query_object->term_id;
-
-		$jsonld = $this->get( $term_id, Jsonld_Context_Enum::PAGE );
-
-		// Bail out if the JSON-LD is empty.
-		if ( empty( $jsonld ) ) {
-			return;
-		}
-
-		$jsonld_string = wp_json_encode( $jsonld );
-
-		$jsonld_term_html_output = '<script type="application/ld+json" id="wl-jsonld-term">' . $jsonld_string . '</script>';
-		$jsonld_term_html_output = apply_filters( 'wl_jsonld_term_html_output', $jsonld_term_html_output, $term_id );
-
-		echo $jsonld_term_html_output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- It's an application/ld+json output.
-
-	}
-
-	/**
-	 * Get.
-	 *
-	 * @param $id
-	 * @param $context
-	 * @param $is_recursive_call
-	 *
-	 * @return array
-	 */
-	public function get( $id, $context, $is_recursive_call = false ) {
-		/**
-		 * Support for carousel rich snippet, get jsonld data present
-		 * for all the posts shown in the term page, and add the jsonld data
-		 * to list
-		 *
-		 * see here: https://developers.google.com/search/docs/data-types/carousel
-		 *
-		 * @since 3.26.0
-		 */
-		$jsonld_array = array();
-
-		if ( Jsonld_Context_Enum::PAGE === $context ) {
-			$carousel_data = $this->get_carousel_jsonld( $id );
-			if ( $carousel_data ) {
-				$jsonld_array[] = $carousel_data;
-			}
-		}
-
-		$entities_jsonld_array = $this->get_entity_jsonld( $id, $context );
-
-		$result = array(
-			'jsonld'     => array_merge( $jsonld_array, $entities_jsonld_array ),
-			'references' => array(),
-		);
-
-		/**
-		 * @since 3.26.3
-		 * Filter: wl_term_jsonld_array
-		 * @var $id int Term id
-		 * @var $jsonld_array array An array containing jsonld for term and entities.
-		 */
-		$arr = apply_filters( 'wl_term_jsonld_array', $result, $id );
-
-		$references = array();
-
-		// Don't expand nested references, it will lead to an infinite loop.
-		if ( ! $is_recursive_call ) {
-			/**
-			 * @since 3.32.0
-			 * Expand the references returned by this filter.
-			 */
-			$references = $this->expand_references( $arr['references'] );
-		}
-
-		$jsonld_array = array_merge( $arr['jsonld'], $references );
-
-		$this->set_terms_request( $jsonld_array, $id, $context );
-
-		return $jsonld_array;
-	}
-
-	/**
-	 * Get term url.
-	 *
-	 * @param $id
-	 *
-	 * @return array|false|int|mixed|string|WP_Error|WP_Term|null
-	 */
-	private function get_term_url( $id ) {
-		if ( null === $id ) {
-			return isset( $_SERVER['REQUEST_URI'] ) ? filter_var( wp_unslash( $_SERVER['REQUEST_URI'] ), FILTER_SANITIZE_URL ) : '';
-		}
-
-		$maybe_url = get_term_meta( $id, Wordlift_Url_Property_Service::META_KEY, true );
-		if ( ! empty( $maybe_url ) ) {
-			return $maybe_url;
-		}
-
-		return get_term_link( $id );
-	}
-
-	/**
-	 * Return jsonld for entities bound to terms.
-	 *
-	 * @param int $term_id Term ID.
-	 * @param int $context A context for the JSON-LD generation, valid values in Jsonld_Context_Enum.
-	 *
-	 * @return array
-	 */
-	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	private function get_entity_jsonld( $term_id, $context ) {
-
-		// The `_wl_entity_id` are URIs.
-		$entity_ids         = get_term_meta( $term_id, '_wl_entity_id' );
-		$entity_uri_service = $this->entity_uri_service;
-
-		$wordlift_jsonld_service = Wordlift_Jsonld_Service::get_instance();
-
-		$local_entity_ids = array_filter(
-			$entity_ids,
-			function ( $uri ) use ( $entity_uri_service ) {
-				return $entity_uri_service->is_internal( $uri );
-			}
-		);
-
-		// Bail out if there are no entities.
-		if ( empty( $local_entity_ids ) ) {
-			return array();
-		}
-
-		$post            = $this->entity_uri_service->get_entity( array_shift( $local_entity_ids ) );
-		$entities_jsonld = $wordlift_jsonld_service->get_jsonld( false, $post->ID );
-		// Reset the `url` to the term page.
-		$entities_jsonld[0]['url'] = get_term_link( $term_id );
-
-		return $entities_jsonld;
-	}
-
-	/**
-	 * @param $references
-	 *
-	 * @return array
-	 */
-	private function expand_references( $references ) {
-		if ( ! is_array( $references ) ) {
-			return array();
-		}
-		$references_jsonld = array();
-		// Expand the references.
-		foreach ( $references as $reference ) {
-			if ( $reference instanceof Term_Reference ) {
-				// Second level references won't be expanded.
-				$references_jsonld[] = current( $this->get( $reference->get_id(), Jsonld_Context_Enum::UNKNOWN, true ) );
-			} elseif ( is_numeric( $reference ) ) {
-				$ref_2               = array();
-				$ref_info_2          = array();
-				$references_jsonld[] = $this->post_id_to_jsonld_converter->convert( $reference, $ref_2, $ref_info_2, new Relations() );
-			} elseif ( $reference instanceof Post_Reference ) {
-				$ref_2               = array();
-				$ref_info_2          = array();
-				$references_jsonld[] = $this->post_id_to_jsonld_converter->convert( $reference->get_id(), $ref_2, $ref_info_2, new Relations() );
-			}
-		}
-
-		return $references_jsonld;
-	}
-
-	/**
-	 * Set events request.
-	 *
-	 * @param $jsonld_arr array The final jsonld before outputting to page.
-	 * @param $term_id int The term id for which the jsonld is generated.
-	 * @param $context int A context for the JSON-LD generation, valid values in Jsonld_Context_Enum
-	 */
-	private function set_terms_request( $jsonld_arr, $term_id, $context ) {
-		// If context is not PAGE or the array is empty, return early.
-		if ( Jsonld_Context_Enum::PAGE !== $context || empty( $jsonld_arr[0] ) ) {
-			return;
-		}
-
-		// Flag to indicate if we should make an API request.
-		$change_status = false;
-
-		// Get data from the array.
-		$data = $jsonld_arr[0];
-
-		// Fetch the initial 'about' and 'mentions' counts from term meta.
-		$counts = [
-			'about'    => get_term_meta( $term_id, 'wl_about_count', true ) ? : 0,
-			'mentions' => get_term_meta( $term_id, 'wl_mentions_count', true ) ? : 0,
-		];
-
-		// Iterate over the counts array.
-		foreach ( $counts as $key => $count ) {
-			// Check if data has 'about' or 'mentions' and the count is different from the existing meta value.
-			if ( ! empty( $data[ $key ] ) ) {
-				$new_count = count( $data[ $key ] );
-				if ( $count !== $new_count ) {
-					// Set flag to true if counts have changed.
-					$change_status = true;
-
-					// Update the counts array with new count.
-					$counts[ $key ] = $new_count;
-
-					// Update term meta with new count.
-					update_term_meta( $term_id, 'wl_' . $key . '_count', $new_count );
-				}
-			}
-		}
-
-		// If the count has changed, make the API request.
-		if ( $change_status ) {
-			$this->api_service->request(
-				'POST',
-				'/plugin/events',
-				[ 'Content-Type' => 'application/json' ],
-				wp_json_encode( [
-					'source' => 'jsonld',
-					'args'   => [
-						[ 'about_count' => $counts['about'] ],
-						[ 'mentions_count' => $counts['mentions'] ],
-					],
-					'url'    => $this->get_term_url( $term_id ),
-				] ),
-				0.001,
-				null,
-				[ 'blocking' => false ]
-			);
-		}
-	}
+    /**
+     * The {@link Wordlift_Entity_Uri_Service} instance.
+     *
+     * @since 3.20.0
+     * @access private
+     * @var \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
+     */
+    private $entity_uri_service;
+
+    /**
+     * Instance.
+     *
+     * @var Wordlift_Term_JsonLd_Adapter
+     */
+    private static $instance;
+
+    /**
+     * @var Wordlift_Post_Converter
+     */
+    private $post_id_to_jsonld_converter;
+
+    /**
+     * The {@link Api_Service} used to communicate with the remote APIs.
+     *
+     * @access private
+     * @var Default_Api_Service
+     */
+    private $api_service;
+
+    /**
+     * Wordlift_Term_JsonLd_Adapter constructor.
+     *
+     * @param \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
+     * @param \Wordlift_Post_Converter     $post_id_to_jsonld_converter The {@link Wordlift_Post_Converter} instance.
+     *
+     * @since 3.20.0
+     */
+    public function __construct( $entity_uri_service, $post_id_to_jsonld_converter ) {
+
+        add_action( 'wp_head', array( $this, 'wp_head' ) );
+
+        $this->api_service                 = Default_Api_Service::get_instance();
+        $this->entity_uri_service          = $entity_uri_service;
+        $this->post_id_to_jsonld_converter = $post_id_to_jsonld_converter;
+
+        self::$instance = $this;
+    }
+
+    /**
+     * Get instance.
+     *
+     * @return Wordlift_Term_JsonLd_Adapter|static
+     */
+    public static function get_instance() {
+        return self::$instance;
+    }
+
+    /**
+     * Adds carousel json ld data to term page if the conditions match
+     *
+     * @return array|boolean
+     */
+    public function get_carousel_jsonld( $id = null ) {
+        $posts       = $this->get_posts( $id );
+        $post_jsonld = array();
+        if ( ! is_array( $posts ) || count( $posts ) < 2 ) {
+            // Bail out if no posts are present.
+            return false;
+        }
+
+        if ( $id !== null ) {
+            $term                       = get_term( $id );
+            $post_jsonld['description'] = wp_strip_all_tags( strip_shortcodes( $term->description ) );
+            $thumbnail_id               = get_term_meta( $id, 'thumbnail_id', true );
+            if ( ! empty( $thumbnail_id ) ) {
+                $post_jsonld['image'] = wp_get_attachment_url( $thumbnail_id );
+            }
+        }
+
+        // More than 2 items are present, so construct the post_jsonld data
+        $post_jsonld['@context']        = 'https://schema.org';
+        $post_jsonld['@type']           = 'ItemList';
+        $post_jsonld['url']             = $this->get_term_url( $id );
+        $post_jsonld['itemListElement'] = array();
+        $position                       = 1;
+
+        foreach ( $posts as $post_id ) {
+            $result = array(
+                '@type'    => 'ListItem',
+                'position' => $position,
+                /**
+                 * We can't use `item` here unless we change the URL for the item to point to the current page.
+                 *
+                 * See https://developers.google.com/search/docs/data-types/carousel
+                 */
+                'url'      => apply_filters( 'wl_carousel_post_list_item_url', get_permalink( $post_id ), $post_id ),
+            );
+            array_push( $post_jsonld['itemListElement'], $result );
+            ++ $position;
+        }
+
+        return $post_jsonld;
+    }
+
+    /**
+     * Get posts.
+     *
+     * @param $id
+     *
+     * @return array|int[]|string[]|WP_Error|null
+     */
+    private function get_posts( $id ) {
+        global $wp_query;
+
+        if ( $wp_query->posts !== null ) {
+            return array_map(
+                function ( $post ) {
+                    return $post->ID;
+                },
+                $wp_query->posts
+            );
+        }
+
+        if ( $id === null ) {
+            return null;
+        }
+
+        $term = get_term( $id );
+
+        return get_objects_in_term( $id, $term->taxonomy );
+    }
+
+    /**
+     * Hook to `wp_head` to print the JSON-LD.
+     *
+     * @since 3.20.0
+     */
+    public function wp_head() {
+        $query_object = get_queried_object();
+
+        // Check if it is a term page.
+        if ( ! $query_object instanceof WP_Term ) {
+            return;
+        }
+
+        // Bail out if `wl_jsonld_enabled` isn't enabled.
+        if ( ! apply_filters( 'wl_jsonld_enabled', true ) ) {
+            return;
+        }
+
+        $term_id = $query_object->term_id;
+
+        $jsonld = $this->get( $term_id, Jsonld_Context_Enum::PAGE );
+
+        // Bail out if the JSON-LD is empty.
+        if ( empty( $jsonld ) ) {
+            return;
+        }
+
+        $jsonld_string = wp_json_encode( $jsonld );
+
+        $jsonld_term_html_output = '<script type="application/ld+json" id="wl-jsonld-term">' . $jsonld_string . '</script>';
+        $jsonld_term_html_output = apply_filters( 'wl_jsonld_term_html_output', $jsonld_term_html_output, $term_id );
+
+        echo $jsonld_term_html_output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- It's an application/ld+json output.
+
+    }
+
+    /**
+     * Get.
+     *
+     * @param $id
+     * @param $context
+     * @param $is_recursive_call
+     *
+     * @return array
+     */
+    public function get( $id, $context, $is_recursive_call = false ) {
+        /**
+         * Support for carousel rich snippet, get jsonld data present
+         * for all the posts shown in the term page, and add the jsonld data
+         * to list
+         *
+         * see here: https://developers.google.com/search/docs/data-types/carousel
+         *
+         * @since 3.26.0
+         */
+        $jsonld_array = array();
+
+        if ( Jsonld_Context_Enum::PAGE === $context ) {
+            $carousel_data = $this->get_carousel_jsonld( $id );
+            if ( $carousel_data ) {
+                $jsonld_array[] = $carousel_data;
+            }
+        }
+
+        $entities_jsonld_array = $this->get_entity_jsonld( $id, $context );
+
+        $result = array(
+            'jsonld'     => array_merge( $jsonld_array, $entities_jsonld_array ),
+            'references' => array(),
+        );
+
+        /**
+         * @since 3.26.3
+         * Filter: wl_term_jsonld_array
+         * @var $id int Term id
+         * @var $jsonld_array array An array containing jsonld for term and entities.
+         */
+        $arr = apply_filters( 'wl_term_jsonld_array', $result, $id );
+
+        $references = array();
+
+        // Don't expand nested references, it will lead to an infinite loop.
+        if ( ! $is_recursive_call ) {
+            /**
+             * @since 3.32.0
+             * Expand the references returned by this filter.
+             */
+            $references = $this->expand_references( $arr['references'] );
+        }
+
+        $jsonld_array = array_merge( $arr['jsonld'], $references );
+
+        $this->set_terms_request( $jsonld_array, $id, $context );
+
+        return $jsonld_array;
+    }
+
+    /**
+     * Get term url.
+     *
+     * @param $id
+     *
+     * @return array|false|int|mixed|string|WP_Error|WP_Term|null
+     */
+    private function get_term_url( $id ) {
+        if ( null === $id ) {
+            return isset( $_SERVER['REQUEST_URI'] ) ? filter_var( wp_unslash( $_SERVER['REQUEST_URI'] ), FILTER_SANITIZE_URL ) : '';
+        }
+
+        $maybe_url = get_term_meta( $id, Wordlift_Url_Property_Service::META_KEY, true );
+        if ( ! empty( $maybe_url ) ) {
+            return $maybe_url;
+        }
+
+        return get_term_link( $id );
+    }
+
+    /**
+     * Return jsonld for entities bound to terms.
+     *
+     * @param int $term_id Term ID.
+     * @param int $context A context for the JSON-LD generation, valid values in Jsonld_Context_Enum.
+     *
+     * @return array
+     */
+    // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+    private function get_entity_jsonld( $term_id, $context ) {
+
+        // The `_wl_entity_id` are URIs.
+        $entity_ids         = get_term_meta( $term_id, '_wl_entity_id' );
+        $entity_uri_service = $this->entity_uri_service;
+
+        $wordlift_jsonld_service = Wordlift_Jsonld_Service::get_instance();
+
+        $local_entity_ids = array_filter(
+            $entity_ids,
+            function ( $uri ) use ( $entity_uri_service ) {
+                return $entity_uri_service->is_internal( $uri );
+            }
+        );
+
+        // Bail out if there are no entities.
+        if ( empty( $local_entity_ids ) ) {
+            return array();
+        }
+
+        $post            = $this->entity_uri_service->get_entity( array_shift( $local_entity_ids ) );
+        $entities_jsonld = $wordlift_jsonld_service->get_jsonld( false, $post->ID );
+        // Reset the `url` to the term page.
+        $entities_jsonld[0]['url'] = get_term_link( $term_id );
+
+        return $entities_jsonld;
+    }
+
+    /**
+     * @param $references
+     *
+     * @return array
+     */
+    private function expand_references( $references ) {
+        if ( ! is_array( $references ) ) {
+            return array();
+        }
+        $references_jsonld = array();
+        // Expand the references.
+        foreach ( $references as $reference ) {
+            if ( $reference instanceof Term_Reference ) {
+                // Second level references won't be expanded.
+                $references_jsonld[] = current( $this->get( $reference->get_id(), Jsonld_Context_Enum::UNKNOWN, true ) );
+            } elseif ( is_numeric( $reference ) ) {
+                $ref_2               = array();
+                $ref_info_2          = array();
+                $references_jsonld[] = $this->post_id_to_jsonld_converter->convert( $reference, $ref_2, $ref_info_2, new Relations() );
+            } elseif ( $reference instanceof Post_Reference ) {
+                $ref_2               = array();
+                $ref_info_2          = array();
+                $references_jsonld[] = $this->post_id_to_jsonld_converter->convert( $reference->get_id(), $ref_2, $ref_info_2, new Relations() );
+            }
+        }
+
+        return $references_jsonld;
+    }
+
+    /**
+     * Set events request.
+     *
+     * @param $jsonld_arr array The final jsonld before outputting to page.
+     * @param $term_id int The term id for which the jsonld is generated.
+     * @param $context int A context for the JSON-LD generation, valid values in Jsonld_Context_Enum
+     */
+    private function set_terms_request( $jsonld_arr, $term_id, $context ) {
+        // If context is not PAGE or the array is empty, return early.
+        if ( Jsonld_Context_Enum::PAGE !== $context || empty( $jsonld_arr[0] ) ) {
+            return;
+        }
+
+        // Flag to indicate if we should make an API request.
+        $change_status = false;
+
+        // Get data from the array.
+        $data = $jsonld_arr[0];
+
+        // Fetch the initial 'about' and 'mentions' counts from term meta.
+        $counts = [
+            'about'    => get_term_meta( $term_id, 'wl_about_count', true ) ? : 0,
+            'mentions' => get_term_meta( $term_id, 'wl_mentions_count', true ) ? : 0,
+        ];
+
+        // Iterate over the counts array.
+        foreach ( $counts as $key => $count ) {
+            // Check if data has 'about' or 'mentions' and the count is different from the existing meta value.
+            if ( ! empty( $data[ $key ] ) ) {
+                $new_count = count( $data[ $key ] );
+                if ( $count !== $new_count ) {
+                    // Set flag to true if counts have changed.
+                    $change_status = true;
+
+                    // Update the counts array with new count.
+                    $counts[ $key ] = $new_count;
+
+                    // Update term meta with new count.
+                    update_term_meta( $term_id, 'wl_' . $key . '_count', $new_count );
+                }
+            }
+        }
+
+        // If the count has changed, make the API request.
+        if ( $change_status ) {
+            $this->api_service->request(
+                'POST',
+                '/plugin/events',
+                [ 'Content-Type' => 'application/json' ],
+                wp_json_encode( [
+                    'source' => 'jsonld',
+                    'args'   => [
+                        [ 'about_count' => $counts['about'] ],
+                        [ 'mentions_count' => $counts['mentions'] ],
+                    ],
+                    'url'    => $this->get_term_url( $term_id ),
+                ] ),
+                0.001,
+                null,
+                [ 'blocking' => false ]
+            );
+        }
+    }
 }

src/includes/class-wordlift-jsonld-service.php

Indentation +539 added lines, -539 removed lines

@@ -21,546 +21,546 @@
  */
 class Wordlift_Jsonld_Service {
 
-	/**
-	 * Creative work types.
-	 *
-	 * @var string[]
-	 */
-	private static $creative_work_types = array(
-		'AmpStory',
-		'ArchiveComponent',
-		'Article',
-		'Atlas',
-		'Blog',
-		'Book',
-		'Chapter',
-		'Claim',
-		'Clip',
-		'Code',
-		'Collection',
-		'ComicStory',
-		'Comment',
-		'Conversation',
-		'Course',
-		'CreativeWork',
-		'CreativeWorkSeason',
-		'CreativeWorkSeries',
-		'DataCatalog',
-		'Dataset',
-		'DefinedTermSet',
-		'Diet',
-		'DigitalDocument',
-		'Drawing',
-		'EducationalOccupationalCredential',
-		'Episode',
-		'ExercisePlan',
-		'Game',
-		'Guide',
-		'HowTo',
-		'HowToDirection',
-		'HowToSection',
-		'HowToStep',
-		'HowToTip',
-		'HyperToc',
-		'HyperTocEntry',
-		'LearningResource',
-		'Legislation',
-		'Manuscript',
-		'Map',
-		'MathSolver',
-		'MediaObject',
-		'Menu',
-		'MenuSection',
-		'Message',
-		'Movie',
-		'MusicComposition',
-		'MusicPlaylist',
-		'MusicRecording',
-		'Painting',
-		'Photograph',
-		'Play',
-		'Poster',
-		'PublicationIssue',
-		'PublicationVolume',
-		'Quotation',
-		'Review',
-		'Sculpture',
-		'Season',
-		'SheetMusic',
-		'ShortStory',
-		'SoftwareApplication',
-		'SoftwareSourceCode',
-		'SpecialAnnouncement',
-		'Thesis',
-		'TvSeason',
-		'TvSeries',
-		'VisualArtwork',
-		'WebContent',
-		'WebPage',
-		'WebPageElement',
-		'WebSite',
-		'AdvertiserContentArticle',
-		'NewsArticle',
-		'Report',
-		'SatiricalArticle',
-		'ScholarlyArticle',
-		'SocialMediaPosting',
-		'TechArticle',
-		'AnalysisNewsArticle',
-		'AskPublicNewsArticle',
-		'BackgroundNewsArticle',
-		'OpinionNewsArticle',
-		'ReportageNewsArticle',
-		'ReviewNewsArticle',
-		'MedicalScholarlyArticle',
-		'BlogPosting',
-		'DiscussionForumPosting',
-		'LiveBlogPosting',
-		'ApiReference',
-		'Audiobook',
-		'MovieClip',
-		'RadioClip',
-		'TvClip',
-		'VideoGameClip',
-		'ProductCollection',
-		'ComicCoverArt',
-		'Answer',
-		'CorrectionComment',
-		'Question',
-		'PodcastSeason',
-		'RadioSeason',
-		'TvSeason',
-		'BookSeries',
-		'MovieSeries',
-		'Periodical',
-		'PodcastSeries',
-		'RadioSeries',
-		'TvSeries',
-		'VideoGameSeries',
-		'ComicSeries',
-		'Newspaper',
-		'DataFeed',
-		'CompleteDataFeed',
-		'CategoryCodeSet',
-		'NoteDigitalDocument',
-		'PresentationDigitalDocument',
-		'SpreadsheetDigitalDocument',
-		'TextDigitalDocument',
-		'PodcastEpisode',
-		'RadioEpisode',
-		'TvEpisode',
-		'VideoGame',
-		'Recipe',
-		'Course',
-		'Quiz',
-		'LegislationObject',
-		'AudioObject',
-		'DModel',
-		'DataDownload',
-		'ImageObject',
-		'LegislationObject',
-		'MusicVideoObject',
-		'VideoObject',
-		'Audiobook',
-		'Barcode',
-		'EmailMessage',
-		'MusicAlbum',
-		'MusicRelease',
-		'ComicIssue',
-		'ClaimReview',
-		'CriticReview',
-		'EmployerReview',
-		'MediaReview',
-		'Recommendation',
-		'UserReview',
-		'ReviewNewsArticle',
-		'MobileApplication',
-		'VideoGame',
-		'WebApplication',
-		'CoverArt',
-		'ComicCoverArt',
-		'HealthTopicContent',
-		'AboutPage',
-		'CheckoutPage',
-		'CollectionPage',
-		'ContactPage',
-		'FaqPage',
-		'ItemPage',
-		'MedicalWebPage',
-		'ProfilePage',
-		'QaPage',
-		'RealEstateListing',
-		'SearchResultsPage',
-		'MediaGallery',
-		'ImageGallery',
-		'VideoGallery',
-		'SiteNavigationElement',
-		'Table',
-		'WpAdBlock',
-		'WpFooter',
-		'WpHeader',
-		'WpSideBar',
-	);
-
-	/**
-	 * The singleton instance for the JSON-LD service.
-	 *
-	 * @since 3.15.1
-	 *
-	 * @var \Wordlift_Jsonld_Service $instance The singleton instance for the JSON-LD service.
-	 */
-	private static $instance;
-
-	/**
-	 * A {@link Wordlift_Entity_Service} instance.
-	 *
-	 * @since  3.8.0
-	 * @access private
-	 * @var Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
-	 */
-	private $entity_service;
-
-	/**
-	 * A {@link Wordlift_Term_JsonLd_Adapter} instance.
-	 *
-	 * @since  3.32.0
-	 * @access private
-	 * @var Wordlift_Term_JsonLd_Adapter $entity_service A {@link Wordlift_Term_JsonLd_Adapter} instance.
-	 */
-	private $term_jsonld_adapter;
-
-	/**
-	 * A {@link Wordlift_Post_Converter} instance.
-	 *
-	 * @since  3.8.0
-	 * @access private
-	 * @var \Wordlift_Post_Converter A {@link Wordlift_Post_Converter} instance.
-	 */
-	private $converter;
-
-	/**
-	 * A {@link Wordlift_Website_Jsonld_Converter} instance.
-	 *
-	 * @since  3.14.0
-	 * @access private
-	 * @var \Wordlift_Website_Jsonld_Converter A {@link Wordlift_Website_Jsonld_Converter} instance.
-	 */
-	private $website_converter;
-
-	/**
-	 * The {@link Api_Service} used to communicate with the remote APIs.
-	 *
-	 * @access private
-	 * @var Default_Api_Service
-	 */
-	private $api_service;
-
-	/**
-	 * Create a JSON-LD service.
-	 *
-	 * @param \Wordlift_Entity_Service           $entity_service A {@link Wordlift_Entity_Service} instance.
-	 * @param \Wordlift_Post_Converter           $converter A {@link Wordlift_Uri_To_Jsonld_Converter} instance.
-	 * @param \Wordlift_Website_Jsonld_Converter $website_converter A {@link Wordlift_Website_Jsonld_Converter} instance.
-	 * @param \Wordlift_Term_JsonLd_Adapter      $term_jsonld_adapter
-	 *
-	 * @since 3.8.0
-	 */
-	public function __construct( $entity_service, $converter, $website_converter, $term_jsonld_adapter ) {
-
-		$this->api_service         = Default_Api_Service::get_instance();
-		$this->entity_service      = $entity_service;
-		$this->converter           = $converter;
-		$this->website_converter   = $website_converter;
-		$this->term_jsonld_adapter = $term_jsonld_adapter;
-		self::$instance            = $this;
-
-	}
-
-	/**
-	 * Get the singleton instance for the JSON-LD service.
-	 *
-	 * @return \Wordlift_Jsonld_Service The singleton instance for the JSON-LD service.
-	 * @since 3.15.1
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Process calls to the AJAX 'wl_jsonld' endpoint.
-	 *
-	 * @since 3.8.0
-	 */
-	public function get() {
-		// Clear the buffer to be sure someone doesn't mess with our response.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/406.
-		// See https://codex.wordpress.org/AJAX_in_Plugins.
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@ob_clean();
-
-		// Get the parameter from the request.
-		$is_homepage = isset( $_REQUEST['homepage'] ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		$post_id     = isset( $_REQUEST['id'] ) && is_numeric( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : null; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-
-		// Send the generated JSON-LD.
-		$this->send_jsonld( $this->get_jsonld( $is_homepage, $post_id ) );
-
-	}
-
-	/**
-	 * A close of WP's own `wp_send_json` function which uses `application/ld+json` as content type.
-	 *
-	 * @param mixed $response Variable (usually an array or object) to encode as JSON,
-	 *                           then print and die.
-	 *
-	 * @since 3.18.5
-	 */
-	private function send_jsonld( $response ) {
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@header( 'Content-Type: application/ld+json; charset=' . get_option( 'blog_charset' ) );
-		echo wp_json_encode( $response );
-		if ( apply_filters( 'wp_doing_ajax', defined( 'DOING_AJAX' ) && DOING_AJAX ) ) {
-			wp_die();
-		} else {
-			die;
-		}
-	}
-
-	/**
-	 * Get the JSON-LD.
-	 *
-	 * @param bool     $is_homepage Whether the JSON-LD for the homepage is being requested.
-	 * @param int|null $post_id The JSON-LD for the specified {@link WP_Post} id.
-	 * @param int      $context A context for the JSON-LD generation, valid values in Jsonld_Context_Enum.
-	 *
-	 * @return array A JSON-LD structure.
-	 * @since 3.15.1
-	 */
-	public function get_jsonld( $is_homepage = false, $post_id = null, $context = Jsonld_Context_Enum::UNKNOWN ) {
-		// Tell NewRelic to ignore us, otherwise NewRelic customers might receive
-		// e-mails with a low apdex score.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/521
-		Wordlift_NewRelic_Adapter::ignore_apdex();
-
-		// Switch to Website converter if is home page.
-		if ( $is_homepage ) {
-			/**
-			 * Filter: 'wordlift_disable_website_json_ld' - Allow disabling of the json+ld output.
-			 *
-			 * @since  3.14.0
-			 * @api    bool $display_search Whether or not to display json+ld search on the frontend.
-			 */
-			if ( apply_filters( 'wordlift_disable_website_json_ld', false ) ) {
-				return array();
-			}
-
-			// Set a reference to the website_converter.
-			$website_converter = $this->website_converter;
-
-			// Send JSON-LD.
-			return $website_converter->create_schema();
-		}
-
-		// If no id has been provided return an empty array.
-		if ( ! isset( $post_id ) ) {
-			return array();
-		}
-
-		// An array of references which is captured when converting an URI to a
-		// json which we gather to further expand our json-ld.
-		$references       = array();
-		$references_infos = array();
-
-		// Set a reference to the entity_to_jsonld_converter to use in the closures.
-		$entity_to_jsonld_converter = $this->converter;
-
-		$relations = new Relations();
-		$jsonld    = $entity_to_jsonld_converter->convert( $post_id, $references, $references_infos, $relations );
-
-		$graph = new Graph( $jsonld, $entity_to_jsonld_converter, Wordlift_Term_JsonLd_Adapter::get_instance() );
-
-		$schema_type = is_array( $jsonld['@type'] ) ? $jsonld['@type'] : array( $jsonld['@type'] );
-
-		// Add `about`/`mentions` only for `CreativeWork` and descendants.
-		if ( array_intersect( $schema_type, self::$creative_work_types ) ) {
-
-			foreach ( $relations->toArray() as $relation ) {
-
-				// Setting about or mentions by label match is currently supported only for posts
-				if ( Object_Type_Enum::POST !== $relation->get_object()->get_type() ) {
-					continue;
-				}
-
-				// Add the `mentions`/`about` prop.
-				$this->add_mention_or_about( $jsonld, $post_id, $relation );
-			}
-			$graph->set_main_jsonld( $jsonld );
-		}
-
-		$jsonld_arr = $graph->add_references( $references )
-			->add_relations( $relations )
-			->add_required_reference_infos( $references_infos )
-			->render( $context );
-
-		/**
-		 * Filter name: wl_after_get_jsonld
-		 *
-		 * @return array
-		 * @since 3.27.2
-		 * @var $jsonld_arr array The final jsonld before outputting to page.
-		 * @var $post_id int The post id for which the jsonld is generated.
-		 */
-		$jsonld_arr = apply_filters( 'wl_after_get_jsonld', $jsonld_arr, $post_id, $context );
-
-		$this->set_events_request( $jsonld_arr, $post_id, $context );
-
-		return $jsonld_arr;
-	}
-
-	/**
-	 * Write the JSON-LD in the head.
-	 *
-	 * This function isn't actually used, but may be used to quickly enable writing the JSON-LD synchronously to the
-	 * document head, using the `wp_head` hook.
-	 *
-	 * @since 3.18.5
-	 */
-	public function wp_head() {
-
-		// Determine whether this is the home page or whether we're displaying a single post.
-		$is_homepage = is_home() || is_front_page();
-		$post_id     = is_singular() ? get_the_ID() : null;
-
-		$jsonld = wp_json_encode( $this->get_jsonld( $is_homepage, $post_id, Jsonld_Context_Enum::PAGE ) );
-		?>
+    /**
+     * Creative work types.
+     *
+     * @var string[]
+     */
+    private static $creative_work_types = array(
+        'AmpStory',
+        'ArchiveComponent',
+        'Article',
+        'Atlas',
+        'Blog',
+        'Book',
+        'Chapter',
+        'Claim',
+        'Clip',
+        'Code',
+        'Collection',
+        'ComicStory',
+        'Comment',
+        'Conversation',
+        'Course',
+        'CreativeWork',
+        'CreativeWorkSeason',
+        'CreativeWorkSeries',
+        'DataCatalog',
+        'Dataset',
+        'DefinedTermSet',
+        'Diet',
+        'DigitalDocument',
+        'Drawing',
+        'EducationalOccupationalCredential',
+        'Episode',
+        'ExercisePlan',
+        'Game',
+        'Guide',
+        'HowTo',
+        'HowToDirection',
+        'HowToSection',
+        'HowToStep',
+        'HowToTip',
+        'HyperToc',
+        'HyperTocEntry',
+        'LearningResource',
+        'Legislation',
+        'Manuscript',
+        'Map',
+        'MathSolver',
+        'MediaObject',
+        'Menu',
+        'MenuSection',
+        'Message',
+        'Movie',
+        'MusicComposition',
+        'MusicPlaylist',
+        'MusicRecording',
+        'Painting',
+        'Photograph',
+        'Play',
+        'Poster',
+        'PublicationIssue',
+        'PublicationVolume',
+        'Quotation',
+        'Review',
+        'Sculpture',
+        'Season',
+        'SheetMusic',
+        'ShortStory',
+        'SoftwareApplication',
+        'SoftwareSourceCode',
+        'SpecialAnnouncement',
+        'Thesis',
+        'TvSeason',
+        'TvSeries',
+        'VisualArtwork',
+        'WebContent',
+        'WebPage',
+        'WebPageElement',
+        'WebSite',
+        'AdvertiserContentArticle',
+        'NewsArticle',
+        'Report',
+        'SatiricalArticle',
+        'ScholarlyArticle',
+        'SocialMediaPosting',
+        'TechArticle',
+        'AnalysisNewsArticle',
+        'AskPublicNewsArticle',
+        'BackgroundNewsArticle',
+        'OpinionNewsArticle',
+        'ReportageNewsArticle',
+        'ReviewNewsArticle',
+        'MedicalScholarlyArticle',
+        'BlogPosting',
+        'DiscussionForumPosting',
+        'LiveBlogPosting',
+        'ApiReference',
+        'Audiobook',
+        'MovieClip',
+        'RadioClip',
+        'TvClip',
+        'VideoGameClip',
+        'ProductCollection',
+        'ComicCoverArt',
+        'Answer',
+        'CorrectionComment',
+        'Question',
+        'PodcastSeason',
+        'RadioSeason',
+        'TvSeason',
+        'BookSeries',
+        'MovieSeries',
+        'Periodical',
+        'PodcastSeries',
+        'RadioSeries',
+        'TvSeries',
+        'VideoGameSeries',
+        'ComicSeries',
+        'Newspaper',
+        'DataFeed',
+        'CompleteDataFeed',
+        'CategoryCodeSet',
+        'NoteDigitalDocument',
+        'PresentationDigitalDocument',
+        'SpreadsheetDigitalDocument',
+        'TextDigitalDocument',
+        'PodcastEpisode',
+        'RadioEpisode',
+        'TvEpisode',
+        'VideoGame',
+        'Recipe',
+        'Course',
+        'Quiz',
+        'LegislationObject',
+        'AudioObject',
+        'DModel',
+        'DataDownload',
+        'ImageObject',
+        'LegislationObject',
+        'MusicVideoObject',
+        'VideoObject',
+        'Audiobook',
+        'Barcode',
+        'EmailMessage',
+        'MusicAlbum',
+        'MusicRelease',
+        'ComicIssue',
+        'ClaimReview',
+        'CriticReview',
+        'EmployerReview',
+        'MediaReview',
+        'Recommendation',
+        'UserReview',
+        'ReviewNewsArticle',
+        'MobileApplication',
+        'VideoGame',
+        'WebApplication',
+        'CoverArt',
+        'ComicCoverArt',
+        'HealthTopicContent',
+        'AboutPage',
+        'CheckoutPage',
+        'CollectionPage',
+        'ContactPage',
+        'FaqPage',
+        'ItemPage',
+        'MedicalWebPage',
+        'ProfilePage',
+        'QaPage',
+        'RealEstateListing',
+        'SearchResultsPage',
+        'MediaGallery',
+        'ImageGallery',
+        'VideoGallery',
+        'SiteNavigationElement',
+        'Table',
+        'WpAdBlock',
+        'WpFooter',
+        'WpHeader',
+        'WpSideBar',
+    );
+
+    /**
+     * The singleton instance for the JSON-LD service.
+     *
+     * @since 3.15.1
+     *
+     * @var \Wordlift_Jsonld_Service $instance The singleton instance for the JSON-LD service.
+     */
+    private static $instance;
+
+    /**
+     * A {@link Wordlift_Entity_Service} instance.
+     *
+     * @since  3.8.0
+     * @access private
+     * @var Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
+     */
+    private $entity_service;
+
+    /**
+     * A {@link Wordlift_Term_JsonLd_Adapter} instance.
+     *
+     * @since  3.32.0
+     * @access private
+     * @var Wordlift_Term_JsonLd_Adapter $entity_service A {@link Wordlift_Term_JsonLd_Adapter} instance.
+     */
+    private $term_jsonld_adapter;
+
+    /**
+     * A {@link Wordlift_Post_Converter} instance.
+     *
+     * @since  3.8.0
+     * @access private
+     * @var \Wordlift_Post_Converter A {@link Wordlift_Post_Converter} instance.
+     */
+    private $converter;
+
+    /**
+     * A {@link Wordlift_Website_Jsonld_Converter} instance.
+     *
+     * @since  3.14.0
+     * @access private
+     * @var \Wordlift_Website_Jsonld_Converter A {@link Wordlift_Website_Jsonld_Converter} instance.
+     */
+    private $website_converter;
+
+    /**
+     * The {@link Api_Service} used to communicate with the remote APIs.
+     *
+     * @access private
+     * @var Default_Api_Service
+     */
+    private $api_service;
+
+    /**
+     * Create a JSON-LD service.
+     *
+     * @param \Wordlift_Entity_Service           $entity_service A {@link Wordlift_Entity_Service} instance.
+     * @param \Wordlift_Post_Converter           $converter A {@link Wordlift_Uri_To_Jsonld_Converter} instance.
+     * @param \Wordlift_Website_Jsonld_Converter $website_converter A {@link Wordlift_Website_Jsonld_Converter} instance.
+     * @param \Wordlift_Term_JsonLd_Adapter      $term_jsonld_adapter
+     *
+     * @since 3.8.0
+     */
+    public function __construct( $entity_service, $converter, $website_converter, $term_jsonld_adapter ) {
+
+        $this->api_service         = Default_Api_Service::get_instance();
+        $this->entity_service      = $entity_service;
+        $this->converter           = $converter;
+        $this->website_converter   = $website_converter;
+        $this->term_jsonld_adapter = $term_jsonld_adapter;
+        self::$instance            = $this;
+
+    }
+
+    /**
+     * Get the singleton instance for the JSON-LD service.
+     *
+     * @return \Wordlift_Jsonld_Service The singleton instance for the JSON-LD service.
+     * @since 3.15.1
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Process calls to the AJAX 'wl_jsonld' endpoint.
+     *
+     * @since 3.8.0
+     */
+    public function get() {
+        // Clear the buffer to be sure someone doesn't mess with our response.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/406.
+        // See https://codex.wordpress.org/AJAX_in_Plugins.
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+        @ob_clean();
+
+        // Get the parameter from the request.
+        $is_homepage = isset( $_REQUEST['homepage'] ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+        $post_id     = isset( $_REQUEST['id'] ) && is_numeric( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : null; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+
+        // Send the generated JSON-LD.
+        $this->send_jsonld( $this->get_jsonld( $is_homepage, $post_id ) );
+
+    }
+
+    /**
+     * A close of WP's own `wp_send_json` function which uses `application/ld+json` as content type.
+     *
+     * @param mixed $response Variable (usually an array or object) to encode as JSON,
+     *                           then print and die.
+     *
+     * @since 3.18.5
+     */
+    private function send_jsonld( $response ) {
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+        @header( 'Content-Type: application/ld+json; charset=' . get_option( 'blog_charset' ) );
+        echo wp_json_encode( $response );
+        if ( apply_filters( 'wp_doing_ajax', defined( 'DOING_AJAX' ) && DOING_AJAX ) ) {
+            wp_die();
+        } else {
+            die;
+        }
+    }
+
+    /**
+     * Get the JSON-LD.
+     *
+     * @param bool     $is_homepage Whether the JSON-LD for the homepage is being requested.
+     * @param int|null $post_id The JSON-LD for the specified {@link WP_Post} id.
+     * @param int      $context A context for the JSON-LD generation, valid values in Jsonld_Context_Enum.
+     *
+     * @return array A JSON-LD structure.
+     * @since 3.15.1
+     */
+    public function get_jsonld( $is_homepage = false, $post_id = null, $context = Jsonld_Context_Enum::UNKNOWN ) {
+        // Tell NewRelic to ignore us, otherwise NewRelic customers might receive
+        // e-mails with a low apdex score.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/521
+        Wordlift_NewRelic_Adapter::ignore_apdex();
+
+        // Switch to Website converter if is home page.
+        if ( $is_homepage ) {
+            /**
+             * Filter: 'wordlift_disable_website_json_ld' - Allow disabling of the json+ld output.
+             *
+             * @since  3.14.0
+             * @api    bool $display_search Whether or not to display json+ld search on the frontend.
+             */
+            if ( apply_filters( 'wordlift_disable_website_json_ld', false ) ) {
+                return array();
+            }
+
+            // Set a reference to the website_converter.
+            $website_converter = $this->website_converter;
+
+            // Send JSON-LD.
+            return $website_converter->create_schema();
+        }
+
+        // If no id has been provided return an empty array.
+        if ( ! isset( $post_id ) ) {
+            return array();
+        }
+
+        // An array of references which is captured when converting an URI to a
+        // json which we gather to further expand our json-ld.
+        $references       = array();
+        $references_infos = array();
+
+        // Set a reference to the entity_to_jsonld_converter to use in the closures.
+        $entity_to_jsonld_converter = $this->converter;
+
+        $relations = new Relations();
+        $jsonld    = $entity_to_jsonld_converter->convert( $post_id, $references, $references_infos, $relations );
+
+        $graph = new Graph( $jsonld, $entity_to_jsonld_converter, Wordlift_Term_JsonLd_Adapter::get_instance() );
+
+        $schema_type = is_array( $jsonld['@type'] ) ? $jsonld['@type'] : array( $jsonld['@type'] );
+
+        // Add `about`/`mentions` only for `CreativeWork` and descendants.
+        if ( array_intersect( $schema_type, self::$creative_work_types ) ) {
+
+            foreach ( $relations->toArray() as $relation ) {
+
+                // Setting about or mentions by label match is currently supported only for posts
+                if ( Object_Type_Enum::POST !== $relation->get_object()->get_type() ) {
+                    continue;
+                }
+
+                // Add the `mentions`/`about` prop.
+                $this->add_mention_or_about( $jsonld, $post_id, $relation );
+            }
+            $graph->set_main_jsonld( $jsonld );
+        }
+
+        $jsonld_arr = $graph->add_references( $references )
+            ->add_relations( $relations )
+            ->add_required_reference_infos( $references_infos )
+            ->render( $context );
+
+        /**
+         * Filter name: wl_after_get_jsonld
+         *
+         * @return array
+         * @since 3.27.2
+         * @var $jsonld_arr array The final jsonld before outputting to page.
+         * @var $post_id int The post id for which the jsonld is generated.
+         */
+        $jsonld_arr = apply_filters( 'wl_after_get_jsonld', $jsonld_arr, $post_id, $context );
+
+        $this->set_events_request( $jsonld_arr, $post_id, $context );
+
+        return $jsonld_arr;
+    }
+
+    /**
+     * Write the JSON-LD in the head.
+     *
+     * This function isn't actually used, but may be used to quickly enable writing the JSON-LD synchronously to the
+     * document head, using the `wp_head` hook.
+     *
+     * @since 3.18.5
+     */
+    public function wp_head() {
+
+        // Determine whether this is the home page or whether we're displaying a single post.
+        $is_homepage = is_home() || is_front_page();
+        $post_id     = is_singular() ? get_the_ID() : null;
+
+        $jsonld = wp_json_encode( $this->get_jsonld( $is_homepage, $post_id, Jsonld_Context_Enum::PAGE ) );
+        ?>
 		<script type="application/ld+json"><?php echo esc_html( $jsonld ); ?></script>
 		<?php
-	}
-
-	/**
-	 * @param array    $jsonld
-	 * @param Relation $relation
-	 *
-	 * @return void
-	 */
-	private function add_mention_or_about( &$jsonld, $post_id, $relation ) {
-		$content_service = Wordpress_Content_Service::get_instance();
-		$entity_service  = Wordlift_Entity_Service::get_instance();
-
-		$object     = $relation->get_object();
-		$entity_uri = $content_service->get_entity_id( $object );
-		$labels     = $entity_service->get_labels( $object->get_id(), $object->get_type() );
-
-		$escaped_labels = array_map(
-			function ( $value ) {
-				return preg_quote( $value, '/' );
-			},
-			$labels
-		);
-
-		$matches = false;
-
-		// When the title is empty, then we shouldn't yield a match to about section.
-		if ( array_filter( $escaped_labels ) ) {
-			// Check if the labels match any part of the title.
-			$post    = get_post( $post_id );
-			$matches = $this->check_title_match( $escaped_labels, $post->post_title );
-		}
-
-		if ( $entity_uri ) {
-			// If the title matches, assign the entity to the about, otherwise to the mentions.
-			$property_name              = $matches ? 'about' : 'mentions';
-			$jsonld[ $property_name ]   = isset( $jsonld[ $property_name ] ) ? (array) $jsonld[ $property_name ] : array();
-			$jsonld[ $property_name ][] = array( '@id' => $entity_uri );
-		}
-
-	}
-
-	/**
-	 * Check if the labels match any part of the title.
-	 *
-	 * @param $labels array The labels to check.
-	 * @param $title string The title to check.
-	 *
-	 * @return boolean
-	 */
-	public function check_title_match( $labels, $title ) {
-
-		// If the title is empty, then we shouldn't yield a match to about section.
-		if ( empty( $title ) ) {
-			return false;
-		}
-
-		// Check if the labels match any part of the title.
-		return 1 === preg_match( '/\b(' . implode( '|', $labels ) . ')\b/iu', $title );
-
-	}
-
-	/**
-	 * Set events request.
-	 *
-	 * @param $jsonld_arr array The final jsonld before outputting to page.
-	 * @param $post_id int The post id for which the jsonld is generated.
-	 * @param $context int A context for the JSON-LD generation, valid values in Jsonld_Context_Enum
-	 */
-	private function set_events_request( $jsonld_arr, $post_id, $context ) {
-		// If context is not PAGE or the array is empty, return early.
-		if ( Jsonld_Context_Enum::PAGE !== $context || empty( $jsonld_arr[0] ) ) {
-			return;
-		}
-
-		// Flag to indicate if we should make an API request.
-		$change_status = false;
-
-		// Get data from the array.
-		$data = $jsonld_arr[0];
-
-		// Fetch the initial 'about' and 'mentions' counts from post meta.
-		$counts = [
-			'about'    => get_post_meta( $post_id, 'wl_about_count', true ) ? : 0,
-			'mentions' => get_post_meta( $post_id, 'wl_mentions_count', true ) ? : 0,
-		];
-
-		// Iterate over the counts array.
-		foreach ( $counts as $key => $count ) {
-			// Check if data has 'about' or 'mentions' and the count is different from the existing meta value.
-			if ( ! empty( $data[ $key ] ) ) {
-				$new_count = count( $data[ $key ] );
-				if ( $count !== $new_count ) {
-					// Set flag to true if counts have changed.
-					$change_status = true;
-
-					// Update the counts array with new count.
-					$counts[ $key ] = $new_count;
-
-					// Update post meta with new count.
-					update_post_meta( $post_id, 'wl_' . $key . '_count', $new_count );
-				}
-			}
-		}
-
-		// If the count has changed, make the API request.
-		if ( $change_status ) {
-			$this->api_service->request(
-				'POST',
-				'/plugin/events',
-				[ 'Content-Type' => 'application/json' ],
-				wp_json_encode( [
-					'source' => 'jsonld',
-					'args'   => [
-						[ 'about_count' => $counts['about'] ],
-						[ 'mentions_count' => $counts['mentions'] ],
-					],
-					'url'    => get_permalink( $post_id ),
-				] ),
-				0.001,
-				null,
-				[ 'blocking' => false ]
-			);
-		}
-	}
+    }
+
+    /**
+     * @param array    $jsonld
+     * @param Relation $relation
+     *
+     * @return void
+     */
+    private function add_mention_or_about( &$jsonld, $post_id, $relation ) {
+        $content_service = Wordpress_Content_Service::get_instance();
+        $entity_service  = Wordlift_Entity_Service::get_instance();
+
+        $object     = $relation->get_object();
+        $entity_uri = $content_service->get_entity_id( $object );
+        $labels     = $entity_service->get_labels( $object->get_id(), $object->get_type() );
+
+        $escaped_labels = array_map(
+            function ( $value ) {
+                return preg_quote( $value, '/' );
+            },
+            $labels
+        );
+
+        $matches = false;
+
+        // When the title is empty, then we shouldn't yield a match to about section.
+        if ( array_filter( $escaped_labels ) ) {
+            // Check if the labels match any part of the title.
+            $post    = get_post( $post_id );
+            $matches = $this->check_title_match( $escaped_labels, $post->post_title );
+        }
+
+        if ( $entity_uri ) {
+            // If the title matches, assign the entity to the about, otherwise to the mentions.
+            $property_name              = $matches ? 'about' : 'mentions';
+            $jsonld[ $property_name ]   = isset( $jsonld[ $property_name ] ) ? (array) $jsonld[ $property_name ] : array();
+            $jsonld[ $property_name ][] = array( '@id' => $entity_uri );
+        }
+
+    }
+
+    /**
+     * Check if the labels match any part of the title.
+     *
+     * @param $labels array The labels to check.
+     * @param $title string The title to check.
+     *
+     * @return boolean
+     */
+    public function check_title_match( $labels, $title ) {
+
+        // If the title is empty, then we shouldn't yield a match to about section.
+        if ( empty( $title ) ) {
+            return false;
+        }
+
+        // Check if the labels match any part of the title.
+        return 1 === preg_match( '/\b(' . implode( '|', $labels ) . ')\b/iu', $title );
+
+    }
+
+    /**
+     * Set events request.
+     *
+     * @param $jsonld_arr array The final jsonld before outputting to page.
+     * @param $post_id int The post id for which the jsonld is generated.
+     * @param $context int A context for the JSON-LD generation, valid values in Jsonld_Context_Enum
+     */
+    private function set_events_request( $jsonld_arr, $post_id, $context ) {
+        // If context is not PAGE or the array is empty, return early.
+        if ( Jsonld_Context_Enum::PAGE !== $context || empty( $jsonld_arr[0] ) ) {
+            return;
+        }
+
+        // Flag to indicate if we should make an API request.
+        $change_status = false;
+
+        // Get data from the array.
+        $data = $jsonld_arr[0];
+
+        // Fetch the initial 'about' and 'mentions' counts from post meta.
+        $counts = [
+            'about'    => get_post_meta( $post_id, 'wl_about_count', true ) ? : 0,
+            'mentions' => get_post_meta( $post_id, 'wl_mentions_count', true ) ? : 0,
+        ];
+
+        // Iterate over the counts array.
+        foreach ( $counts as $key => $count ) {
+            // Check if data has 'about' or 'mentions' and the count is different from the existing meta value.
+            if ( ! empty( $data[ $key ] ) ) {
+                $new_count = count( $data[ $key ] );
+                if ( $count !== $new_count ) {
+                    // Set flag to true if counts have changed.
+                    $change_status = true;
+
+                    // Update the counts array with new count.
+                    $counts[ $key ] = $new_count;
+
+                    // Update post meta with new count.
+                    update_post_meta( $post_id, 'wl_' . $key . '_count', $new_count );
+                }
+            }
+        }
+
+        // If the count has changed, make the API request.
+        if ( $change_status ) {
+            $this->api_service->request(
+                'POST',
+                '/plugin/events',
+                [ 'Content-Type' => 'application/json' ],
+                wp_json_encode( [
+                    'source' => 'jsonld',
+                    'args'   => [
+                        [ 'about_count' => $counts['about'] ],
+                        [ 'mentions_count' => $counts['mentions'] ],
+                    ],
+                    'url'    => get_permalink( $post_id ),
+                ] ),
+                0.001,
+                null,
+                [ 'blocking' => false ]
+            );
+        }
+    }
 
 }