fix: improve ContentTypeSeo handling and breadcrumb generation (#90)

Author: justlevine

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Unreleased
 
 - feat: Add plugin dependencies header.
+- fix: Improve handling of `ContentTypeSeo` and prevent fatal error when generating breadcrumbs. H/t @MonPetitUd
 - fix: Plugin versions in dependency check logic is now in sync with the version requirements.
 - fix: Update the return type of the `type` field in the `Redirection` model to correctly return a `?string`.
 - chore!: Add `WPGraphQL/RankMath` namespace to root-level files ( `activation.php`, `deactivation.php`, `wp-graphql-rank-math.php` ).

src/Model/ContentNodeSeo.php

@@ -11,6 +11,7 @@
 
 use GraphQL\Error\Error;
 use GraphQL\Error\UserError;
+use RankMath\Helper as RMHelper;
 use WPGraphQL;
 
 /**
@@ -183,6 +184,25 @@ protected function init() {
 		}
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
+	protected function get_breadcrumbs(): ?array {
+		$breadcrumbs = parent::get_breadcrumbs();
+
+		if ( empty( $breadcrumbs ) ) {
+			return null;
+		}
+
+		$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;
+	}
+
 	/**
 	 * {@inheritDoc}
 	 */

src/Model/ContentTypeSeo.php

@@ -11,6 +11,7 @@
 
 use GraphQL\Error\Error;
 use GraphQL\Error\UserError;
+use RankMath\Helper as RMHelper;
 use WPGraphQL;
 
 /**
@@ -53,11 +54,49 @@ public function __construct( string $post_type ) {
 
 		$allowed_fields = [ 'breadcrumbTitle' ];
 
-		global $wp_query;
+		parent::__construct( $object, $capability, $allowed_fields );
+	}
 
-		$wp_query->parse_query( [ 'post_type' => $post_type ] );
+	/**
+	 * {@inheritDoc}
+	 */
+	public function setup(): void {
+		global $wp_query, $post;
 
-		parent::__construct( $object, $capability, $allowed_fields );
+		// Store the global post before overriding.
+		$this->global_post = $post;
+
+		if ( $this->data instanceof \WP_Post_Type ) {
+			/**
+			 * Reset global post
+			 */
+			$GLOBALS['post'] = get_post( 0 ); // phpcs:ignore WordPress.WP.GlobalVariablesOverride
+		}
+
+		// Store the global post before overriding.
+		$this->global_post = $post;
+
+		/**
+		 * Parse the query to tell WordPress how to setup the global state.
+		 */
+		$wp_query->parse_query( [ 'post_type' => $this->data->name ] );
+
+		$wp_query->queried_object_id = $this->data->name;
+		$wp_query->queried_object    = $this->data;
+
+		parent::setup();
+	}
+
+	/**
+	 * Reset global state after the model fields
+	 * have been generated
+	 *
+	 * @return void
+	 */
+	public function tear_down() {
+		$GLOBALS['post'] = $this->global_post; // phpcs:ignore WordPress.WP.GlobalVariablesOverride
+
+		wp_reset_postdata();
 	}
 
 	/**
@@ -77,6 +116,45 @@ protected function init() {
 		}
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
+	protected function get_breadcrumbs(): ?array {
+		$breadcrumbs = parent::get_breadcrumbs();
+
+		// For non posts, we return the breadcrumbs as-is.
+		if ( empty( $breadcrumbs ) || 'post' !== $this->data->name ) {
+			return $breadcrumbs;
+		}
+
+		/**
+		 * @todo This is a workaround since WPGraphQL doesnt support an archive type.
+		 */
+
+		$blog_id = get_option( 'page_for_posts' );
+
+		if ( ! $blog_id ) {
+			return $breadcrumbs;
+		}
+
+		$should_show_blog = RMHelper::get_settings( 'general.breadcrumbs_blog_page' );
+
+		if ( ! $should_show_blog || 'page' !== get_option( 'show_on_front' ) ) {
+			return $breadcrumbs;
+		}
+
+		$breadcrumb_title = RMHelper::get_post_meta( 'breadcrumb_title', $blog_id ) ?: get_the_title( $blog_id );
+		$permalink        = get_permalink( $blog_id );
+
+		$breadcrumbs[] = [
+			'text'     => $breadcrumb_title ?: null,
+			'url'      => $permalink ?: null,
+			'isHidden' => false,
+		];
+
+		return $breadcrumbs;
+	}
+
 	/**
 	 * {@inheritDoc}
 	 */

src/Model/Seo.php

@@ -92,11 +92,6 @@ public function __construct( $wp_object, $capability = '', $allowed_fields = []
 		);
 
 		parent::__construct( $capability, $allowed_fields );
-
-		// Seat up RM Globals.
-		$url = $this->get_object_url();
-
-		$this->setup_post_head( $url );
 	}
 
 	/**
@@ -107,6 +102,11 @@ public function setup(): void {
 		/** @var \RankMath\Paper\Paper $paper */
 		$paper        = Paper::get();
 		$this->helper = $paper;
+
+		// Seat up RM Globals.
+		$url = $this->get_object_url();
+
+		$this->setup_post_head( $url );
 	}
 
 	/**
@@ -169,9 +169,18 @@ protected function init() {
 	 */
 	protected function get_breadcrumbs(): ?array {
 		// Get the crumbs and shape them.
-		$crumbs      = RMBreadcrumbs::get()->get_crumbs();
+		$crumbs = RMBreadcrumbs::get()->get_crumbs();
+
+		if ( empty( $crumbs ) ) {
+			return null;
+		}
+
 		$breadcrumbs = array_map(
 			static function ( $crumb ) {
+				if ( empty( $crumb[1] ) && empty( $crumb[0] ) ) {
+					return null;
+				}
+
 				return [
 					'text'     => $crumb[0] ?? null,
 					'url'      => $crumb[1] ?? null,
@@ -181,11 +190,7 @@ static function ( $crumb ) {
 			$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 );
-		}
+		$breadcrumbs = array_filter( $breadcrumbs );
 
 		return ! empty( $breadcrumbs ) ? $breadcrumbs : null;
 	}

src/Type/WPInterface/NodeWithSeo.php

@@ -79,6 +79,10 @@ public static function get_fields(): array {
 						return null;
 					}
 
+					if ( empty( $source->uri ) ) {
+						return null;
+					}
+
 					$model = self::get_model_for_node( $source );
 
 					if ( empty( $model ) ) {