Skip to content

Back to homepage

Features
Demo
Guides
Blog
Download

Pages

Share

These are examples of queries to fetch page data.

Fetching pages permalink

A single page:

A list of pages:

Top-level pages with their children:

Share

Browse more guides

Getting started

What is GraphQL
What is the GraphQL API for WordPress
Connecting to the GraphQL server from a client
How the plugin maps the WordPress data model into the GraphQL schema
Intro to the GraphiQL client
Intro to the Voyager client
What is schema introspection

Looking forward

Schema namespacing
Nested mutations
Field and directive-based versioning

Querying/mutating WordPress data

Executing Queries and Mutations
Posts
Custom Posts
👉🏽 Pages
Users
Comments
Post Tags
Post Categories
Custom Tags
Custom Categories
Media
Meta Values
Menus
Settings

Directives

@include
@skip

Creating an API

Creating a custom endpoint
Creating a persisted query
Creating a schema configuration
Creating an API hierarchy

Configuring the schema

Namespacing the schema
Using nested mutations
Querying “sensitive” data fields
Querying 'self' fields

Configuring the plugin

Browsing, enabling and disabling modules
Configuring the plugin via the Settings page, environment variables, wp-config, and hooks
Building static sites
Defining the default schema configuration
Modifying the default and max number of results
Adding a custom post type to the schema
Adding a custom tag taxonomy to the schema
Adding a custom category taxonomy to the schema
Defining the allow/denylist for meta values
Disabling mutations
Enabling and configuring the single endpoint
Organizing Custom Endpoints and Persisted Queries by Category
Configuring the GraphiQL client for the single endpoint
Configuring the GraphiQL Explorer
Configuring the Voyager client for the single endpoint
Adding a description to the API
Displaying the plugin's new features
Printing the Settings page with tabs or long format
Defining the Setting's allowed entries

Schema restrictions via code

Restricting access to Custom endpoints and Persisted queries by IP
Removing fields from the schema via hooks

Schema augmentation

Schema extensions via introspection
'oneOf' Input Object
'Enum String' types

Extending the GraphQL API

Creating an extension for the GraphQL API
Creating a type
Adding fields to a type
Creating an interface
Adding mutations
Adding nested mutations
Creating a union type
Creating an input object
Creating a "oneOf" input object
Creating an enum
Creating an 'enum string'
Creating a custom scalar
Creating an error payload type
Creating a directive
Filtering results from a field
Validating constraints for field and directive arguments
Adding a field to all custom post types
Versioning fields and directives

Subscribe to our newsletter

Receive timely updates on the state of the GraphQL API for WordPress: new releases, documentation, blog posts, 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