Skip to content

Back to homepage

Features
Demo
Guides
Blog
Download

Settings

Share

These are examples of queries to fetch settings from the wp_options table.

Fetching settings permalink

Fetch the site's URL, name and description:

Share

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 and mutating data

Posts
Custom Posts
Pages
Users
Comments
Tags
Categories
Media
Menus
👉🏽 Settings
Blocks

Directives

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

Looking forward

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

Creating an API

Creating a custom endpoint
Creating a persisted query
Creating a schema configuration
Defining access control
Adding HTTP caching
Creating an API hierarchy

Configuring the schema

Namespacing the schema
Using nested mutations
Querying 'unrestricted' fields
Making the API public or private
Executing multiple queries concurrently
Deprecating fields
Using composable directives
Using embeddable fields

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
Defining the allow/denylist for meta values
Disabling mutations
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
Enabling low-level editing of persisted queries
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
Caching the GraphQL schema
Managing who can edit the schema

Connecting

Executing queries against the GraphQL server

Recipes

Strategies for API hierarchies
Removing types from the schema
Security considerations when exposing data in a live API
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
Removing fields from the schema, via hooks
Restricting access to Custom endpoints and Persisted queries, by code

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