Skip to content

Back to homepage

Features
Demo
Guides
Blog
Download

Pages

These are examples of queries to fetch page data.

Fetching pages permalink

A single page:

A list of pages:

Share on 🐦 Twitter | 👎🏾 Facebook

Browse more guides

Getting started

What is GraphQL
What is the GraphQL API for WordPress
Intro to the GraphiQL client
Intro to the Voyager client

Querying data

Posts
Custom Posts
👉🏽 Pages
Users
Comments
Tags
Media
Blocks

Directives

@skip and @include
@default
@removeIfNull
@export
@upperCase, @lowerCase and @titleCase
@translate
@traceExecutionTime
@cache

Looking forward

Multiple query execution
Schema namespacing
Nested mutations
Embeddable fields
Composable directives
Proactive feedback
Field and directive-based versioning

Using the plugin

Creating a custom endpoint
Creating a persisted query
Creating a schema configuration
Defining access control
Making the API public or private
Adding HTTP caching
Creating an API hierarchy

Opt-in features

Deprecating fields
Executing multiple queries concurrently
Namespacing the schema
Using nested mutations
Using embeddable fields
Using composable directives

Configuring the plugin

Browsing, enabling and disabling modules
Configuring the plugin via the Settings page, environment variables, wp-config, and hooks
Defining the default schema configuration
Enabling granular public or private mode
Setting the default cache control max-age
Modifying the default and max number of results
Adding a custom post type to the schema
Disabling mutations
Caching the GraphQL schema
Enabling and configuring the single endpoint
Configuring the GraphiQL client for the single endpoint
Configuring the GraphiQL Explorer
Configuring the Voyager client for the single endpoint
Managing who can edit the schema
Enabling low-level editing of persisted queries
Adding a description to the API
Displaying the plugin's new features

Connecting

Executing queries against the GraphQL server

Recipes

Strategies for API hierarchies
Removing types from the schema
Making directives available to the admin only
Creating language-based endpoints for translating the content of the site
Translating content inside blocks

Extending the GraphQL API

Example of mapping the WordPress data model into a GraphQL schema
Creating an extension for the GraphQL API
Creating a type
Creating an interface
Creating a field resolver
Creating a directive
Creating a mutation resolver
Creating a union type
Creating a custom scalar
Creating an enum
Adding a field to all custom post types
Adding more elements to the schema configuration
Creating a custom access control rule
Creating modules
Creating persisted queries via code
Restricting fields to the WordPress admin
Hooking into Proactive feedback
Versioning fields and directives

Subscribe to our monthly newsletter

We are building the plugin in the open. Learn about our progress: what we are currently working on, new features and documentation added, new blog posts, mentions in the media, and much more.

What’s your email address?

Need help? Integrate GraphQL into your WordPress plugin, with us!

GraphQL integration

Have your users query your plugin's data through GraphQL

Custom extensions

Add your CPTs to the schema, interact with 3rd-party services

Bundled in

Bundle a scoped version of this plugin, within your plugin

👉 Contact us: What do you want to build?

Back to homepage

GraphQL API for WordPress

The most forward-looking and powerful GraphQL experience for WordPress

Features
Demo
Guides
Blog
Download