README

WPGraphQL for Rank Math SEO

🚨 NOTE: This is prerelease software. 🚨

Adds WPGraphQL support for Rank Math SEO. Built with WPGraphQL Plugin Boilerplate.

• Join the WPGraphQL community on Slack.
• Documentation

System Requirements

• PHP 7.4 - 8.2+
• WordPress 6.0+
• WPGraphQL 1.26.0+
• RankMath SEO 1.0.201+

Quick Install

1. Install & activate WPGraphQL.
2. Install & activate Rank Math SEO.
3. Download the latest release .zip file, upload it to your WordPress install, and activate the plugin.

With Composer

composer require axepress/wp-graphql-rank-math

Updating and Versioning

As we work towards a 1.0 Release, we will need to introduce numerous breaking changes. We will do our best to group multiple breaking changes together in a single release, to make it easier on developers to keep their projects up-to-date.

Until we hit v1.0, we're using a modified version of SemVer, where:

• v0.x: "Major" releases. These releases introduce new features, and may contain breaking changes to either the PHP API or the GraphQL schema
• v0.x.y: "Minor" releases. These releases introduce new features and enhancements and address bugs. They do not contain breaking changes.
• v0.x.y.z: "Patch" releases. These releases are reserved for addressing issue with the previous release only.

Development and Support

Development of WPGraphQL for Rank Math SEO is provided by AxePress Development. Community contributions are welcome and encouraged.

Basic support is provided for free, both in this repo and at the #rank-math channel in WPGraphQL Slack.

Priority support and custom development is available to our Sponsors.

Supported Features

• General Settings
• Titles & Meta Settings
• 🏗 SEO data for
  • Single posts, pages, attachments, and CPTs.
  • Post Type archives.
  • Categories, tags, and custom taxonomy terms.
  • Authors (users)
  • Image attributes.
• Sitemaps
• Redirections
• 404 Monitor
• Local SEO and Knowledgegraph
• RSS Feeds

Supported SEO data

• Full head
• RankMath SEO Score
• Basic Meta Attributes: Title, Description, Robots, Focus Keywords, Canonical URL,
• Breadcrumbs
• 🏗 JSON-LD
  • Raw schema
  • Individual JSON-LD attributes
• OpenGraph & Twitter

Usage

Getting Started ( 🎯 You are here! )

• System Requirements
• Installation

Reference

• GraphQL Queries
• WordPress Actions
• WordPress Filters

Testing

1. Update your .env file to your testing environment specifications.
2. Run composer install-test-env to create the test environment.
3. Run your test suite with Codeception. E.g. vendor/bin/codecept run wpunit will run all WPUnit tests.

Credits