How do I query Yoast OpenGraph images with WPGraphQL?

In your GraphQL query, use the 'opengraphImage' field under the 'seo' object, which returns mediaItem type with altText, sourceUrl, and srcSet, as shown in the usage examples. This allows you to fetch optimized images for social sharing directly.

WPGraphQL Yoast SEO or custom REST endpoints for SEO data?

This plugin is better if you're already using WPGraphQL, as it provides a type-safe, consistent interface without building custom endpoints. However, for projects heavily invested in REST API, custom endpoints might offer more control but require extra development work.

Does this plugin support Yoast SEO premium features?

The README doesn't explicitly mention premium features; it focuses on core Yoast data. You may need to check issue reports or contribute to add support for premium-specific fields like additional schemas or redirects.

How to install this plugin via Composer in WordPress?

Run 'composer require ashhitch/wp-graphql-yoast-seo' in your project, then activate it in WordPress. Ensure WPGraphQL and Yoast SEO are already installed and active, as noted in the quick install section.

What are the breaking changes in version 4?

Version 4 requires at least Yoast 14.0.0, which might break sites on older Yoast versions. Always check compatibility before updating, as highlighted in the README's version notes.

Can I use this with Next.js for server-side rendering?

Yes, it's designed for headless setups like Next.js. Query the SEO data via GraphQL during build or runtime, and inject it into your page components for metadata, similar to the Gatsby integration mentioned.

Open-Awesome

WPGraphQL for SEOPress

GPL-3.0PHPv5.0.2

A WPGraphQL extension that exposes Yoast SEO data for WordPress content via GraphQL queries.

GitHub

231 stars48 forks0 contributors

What is WPGraphQL for SEOPress?

WP GraphQL Yoast SEO is a WordPress plugin that extends WPGraphQL to expose Yoast SEO metadata via GraphQL queries. It solves the problem of accessing structured SEO data in headless WordPress setups, allowing developers to fetch titles, meta descriptions, OpenGraph tags, schema markup, and other SEO fields directly through GraphQL. This eliminates the need for traditional WordPress template functions or REST API workarounds for SEO content.

Target Audience

WordPress developers building headless or decoupled WordPress sites using frameworks like Gatsby, Next.js, or React, who need programmatic access to Yoast SEO data. It's also valuable for developers working with WPGraphQL who require comprehensive SEO metadata in their GraphQL schema.

Value Proposition

Developers choose this plugin because it provides a seamless, type-safe way to query Yoast SEO data within the WPGraphQL ecosystem, reducing complexity and improving developer experience for headless WordPress projects. Its comprehensive coverage of Yoast features and active maintenance make it a reliable choice compared to custom solutions.

Overview

This is an extension to the WPGraphQL plugin for Yoast SEO

Use Cases

Best For

Building headless WordPress sites that require SEO metadata in frontend applications
Fetching Yoast SEO data for posts, pages, and custom post types via GraphQL
Implementing structured data (JSON-LD) from Yoast in decoupled architectures
Querying global Yoast configuration settings programmatically
Integrating Yoast breadcrumbs and social metadata into Gatsby or Next.js projects
Accessing WooCommerce product SEO data through GraphQL

Not Ideal For

WordPress sites using SEO plugins other than Yoast (e.g., All in One SEO Pack)
Projects that do not use or plan to implement WPGraphQL for data fetching
Traditional server-rendered WordPress themes that don't require external SEO data access

Pros & Cons

Pros

Comprehensive SEO Coverage

Exposes Yoast data for posts, pages, custom post types, taxonomies, users, and WooCommerce products, as demonstrated in the detailed GraphQL query examples.

Structured Data Support

Provides both raw and parsed schema.org JSON-LD data directly through GraphQL, eliminating manual handling for enhanced search visibility.

Developer-Friendly Setup

Includes a Docker-based development environment with automated WordPress installation and plugin activation, streamlining contributor onboarding.

Active Maintenance

Regular updates and version tracking (e.g., V4 requiring Yoast 14.0.0) show ongoing development, with an open issue system for missing features.

Cons

Dependency on Specific Versions

Breaking changes like V4 mandating Yoast 14.0.0 can disrupt existing implementations, requiring careful version management.

Requires Multiple Plugins

Necessitates both Yoast SEO and WPGraphQL to be installed and active, adding setup complexity and potential points of failure.

Potential Feature Gaps

The README invites users to report missing Yoast data, indicating that not all features may be covered out of the box.

Frequently Asked Questions

Related Projects

WPGraphQL for WooCommerce

Add WooCommerce support and functionality to your WPGraphQL server

Stars703

Forks146

Last commit24 days ago

WPGraphQL for Advanced Custom Fields

Stars617

Forks111

Last commit2 years ago

WPGraphQL JWT Authentication

Authentication for WPGraphQL using JWT (JSON Web Tokens)

Stars363

Forks79

Last commit4 months ago

WPGraphQL Gutenberg

Query gutenberg blocks with wp-graphql

Stars306

Forks59

Last commit1 year ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub