Return expected data when querying seo data of custom taxonomy (#57)

* Update shim to work with custom taxonomies

* Update CHANGELOG.md

* dev: revert and use local parse_query

* dev: move breadcrumb generation to model

* tests: Test custom tax term seo

* fix: reset global authordata on Model::tear_down()

* chore: update changelog

---------

Co-authored-by: David Levine <[email protected]>

Author: lucguerraz

CHANGELOG.md

@@ -1,6 +1,9 @@
 # Changelog
 
 ## Unreleased
+- fix: Fetch the correct SEO data when resolving custom taxonomy terms. Props @lucguerraz
+- dev!: Move `SEO::$global_authordata` property to the `UserSeo` model and make nullable.
+- dev: Move `seo.breadcrumbs` resolution from the `RankMathSeo` interface to the `SEO` model.
 
 ## v0.0.13
 - feat: Expose Redirections to the GraphQL schema.

src/Model/Seo.php

@@ -7,6 +7,7 @@
 
 namespace WPGraphQL\RankMath\Model;
 
+use RankMath\Frontend\Breadcrumbs as RMBreadcrumbs;
 use RankMath\Helper as RMHelper;
 use RankMath\Paper\Paper;
 use WPGraphQL\Model\Model;
@@ -63,13 +64,6 @@ abstract class Seo extends Model {
 	 */
 	protected $global_post;
 
-	/**
-	 * The global authordata at time of Model generation
-	 *
-	 * @var \WP_User
-	 */
-	protected $global_authordata;
-
 	/**
 	 * Constructor.
 	 *
@@ -83,6 +77,7 @@ public function __construct( $object, $capability = '', $allowed_fields = [] ) {
 
 		$allowed_fields = array_merge(
 			[
+				'breadcrumbs',
 				'title',
 				'description',
 				'robots',
@@ -119,6 +114,7 @@ public function setup(): void {
 	protected function init() {
 		if ( empty( $this->fields ) ) {
 			$this->fields = [
+				'breadcrumbs'   => fn (): ?array => $this->get_breadcrumbs(),
 				'title'         => function (): ?string {
 					$title = $this->helper->get_title();
 
@@ -165,6 +161,34 @@ protected function init() {
 		}
 	}
 
+	/**
+	 * Gets and parses the breadcrumbs for the object.
+	 *
+	 * @return ?array<string, string|mixed>[] The breadcrumbs.
+	 */
+	protected function get_breadcrumbs(): ?array {
+		// Get the crumbs and shape them.
+		$crumbs      = RMBreadcrumbs::get()->get_crumbs();
+		$breadcrumbs = array_map(
+			static function ( $crumb ) {
+				return [
+					'text'     => $crumb[0] ?? null,
+					'url'      => $crumb[1] ?? null,
+					'isHidden' => ! empty( $crumb['hide_in_schema'] ),
+				];
+			},
+			$crumbs
+		);
+
+		// Pop the current item's title.
+		$remove_title = ( is_single( $this->database_id ) || is_page( $this->database_id ) ) && RMHelper::get_settings( 'general.breadcrumbs_remove_post_title' );
+		if ( $remove_title ) {
+			array_pop( $breadcrumbs );
+		}
+
+		return ! empty( $breadcrumbs ) ? $breadcrumbs : null;
+	}
+
 	/**
 	 * Gets the hydrated meta, falling back to default settings.
 	 *

src/Model/TermNodeSeo.php

@@ -60,13 +60,13 @@ public function __construct( int $term_id ) {
 	public function setup(): void {
 		global $wp_query, $post;
 
-		/**
-		 * Store the global post before overriding
-		 */
+		// Store the global post before overriding.
 		$this->global_post = $post;
 
-		if ( $this->data instanceof WP_Term ) {
+		// Denylist globally-cached replacements.
+		add_filter( 'rank_math/replacements/non_cacheable', [ $this, 'non_cacheable_replacements' ] );
 
+		if ( $this->data instanceof WP_Term ) {
 			/**
 			 * Reset global post
 			 */
@@ -88,6 +88,12 @@ public function setup(): void {
 						'tag' => $this->data->slug,
 					]
 				);
+			} else {
+				$wp_query->parse_query(
+					[
+						$this->data->taxonomy => $this->data->slug,
+					]
+				);
 			}
 
 			$wp_query->queried_object_id = $this->data->term_id;
@@ -104,7 +110,10 @@ public function setup(): void {
 	 * @return void
 	 */
 	public function tear_down() {
+		remove_filter( 'rank_math/replacements/non_cacheable', [ $this, 'non_cacheable_replacements' ] );
+
 		$GLOBALS['post'] = $this->global_post; // phpcs:ignore WordPress.WP.GlobalVariablesOverride
+
 		wp_reset_postdata();
 	}
 
@@ -150,4 +159,20 @@ protected function get_object_url(): string {
 		}
 		return $term_link;
 	}
+
+	/**
+	 * Adds SEO keys that should not be cached by the Rank Math replacements cache.
+	 *
+	 * @uses rank_math/replacements/non_cacheable
+	 *
+	 * @param string[] $args The keys that should not be cached.
+	 *
+	 * @return string[]
+	 */
+	public function non_cacheable_replacements( array $args ): array {
+		// This is necessary because RM (as of 1.0.117) does not set `term_description` to nocache.
+		$args[] = 'term_description';
+
+		return $args;
+	}
 }

src/Model/UserSeo.php

@@ -22,6 +22,13 @@ class UserSeo extends Seo {
 	 */
 	protected $data;
 
+	/**
+	 * The global authordata at time of Model generation
+	 *
+	 * @var ?\WP_User
+	 */
+	protected $global_authordata;
+
 	/**
 	 * The settings prefix
 	 *
@@ -56,7 +63,7 @@ public function __construct( int $user_id ) {
 	 * {@inheritDoc}
 	 */
 	public function setup(): void {
-		global $wp_query, $post, $authordata;
+		global $wp_query, $post, $author, $authordata;
 
 		// Store variables for resetting at tear down.
 		$this->global_post       = $post;
@@ -77,7 +84,8 @@ public function setup(): void {
 			// Setup globals.
 			$wp_query->is_author         = true;
 			$GLOBALS['authordata']       = $this->data; // phpcs:ignore WordPress.WP.GlobalVariablesOverride
-			$wp_query->queried_object    = get_user_by( 'id', $this->data->ID );
+			$author                      = $this->data->ID; // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedVariableFound,SlevomatCodingStandard.Variables.UnusedVariable.UnusedVariable
+			$wp_query->queried_object    = $this->data;
 			$wp_query->queried_object_id = $this->data->ID;
 		}
 
@@ -91,8 +99,13 @@ public function setup(): void {
 	 * @return void
 	 */
 	public function tear_down() {
-		$GLOBALS['authordata'] = $this->global_authordata; // phpcs:ignore WordPress.WP.GlobalVariablesOverride
-		$GLOBALS['post']       = $this->global_post; // phpcs:ignore WordPress.WP.GlobalVariablesOverride
+		global $author;
+		if ( $this->data instanceof \WP_User ) {
+			$author                = isset( $this->global_authordata ) ? $this->global_authordata->ID : null; // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals
+			$GLOBALS['authordata'] = $this->global_authordata; // phpcs:ignore WordPress.WP.GlobalVariablesOverride
+			$GLOBALS['post']       = $this->global_post; // phpcs:ignore WordPress.WP.GlobalVariablesOverride
+		}
+
 		wp_reset_postdata();
 	}
 

src/Type/WPInterface/Seo.php

@@ -8,7 +8,6 @@
 
 namespace WPGraphQL\RankMath\Type\WPInterface;
 
-use RankMath\Frontend\Breadcrumbs as RMBreadcrumbs;
 use RankMath\Helper;
 use WPGraphQL\RankMath\Model\ContentNodeSeo;
 use WPGraphQL\RankMath\Model\ContentTypeSeo;
@@ -89,36 +88,6 @@ public static function get_fields(): array {
 			$fields['breadcrumbs'] = [
 				'type'        => [ 'list_of' => Breadcrumbs::get_type_name() ],
 				'description' => __( 'The breadcrumbs trail for the given object', 'wp-graphql-rank-math' ),
-				'resolve'     => static function ( $source ) {
-					if ( $source instanceof UserSeo ) {
-						// RankMath uses the global $author for generating crumbs.
-						global $author;
-
-						// phpcs:disable WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedVariableFound
-						$author = $source->ID;
-					}
-
-					// Get the crumbs and shape them.
-					$crumbs      = RMBreadcrumbs::get()->get_crumbs();
-					$breadcrumbs = array_map(
-						static function ( $crumb ) {
-							return [
-								'text'     => $crumb[0] ?? null,
-								'url'      => $crumb[1] ?? null,
-								'isHidden' => ! empty( $crumb['hide_in_schema'] ),
-							];
-						},
-						$crumbs
-					);
-
-					// Pop the current item's title.
-					$remove_title = ( is_single( $source->database_id ) || is_page( $source->database_id ) ) && Helper::get_settings( 'general.breadcrumbs_remove_post_title' );
-					if ( $remove_title ) {
-						array_pop( $breadcrumbs );
-					}
-
-					return ! empty( $breadcrumbs ) ? $breadcrumbs : null;
-				},
 			];
 		}