Guides

📣 We are working on the remaining guides. Subscribe to our monthly newsletter to be notified when they become available.

Getting started

  1. What is GraphQL

  2. What is the GraphQL API for WordPress

  3. Intro to the GraphiQL client

  4. Intro to the Voyager client

Querying data

  1. Posts

  2. Custom Posts

  3. Pages

  4. Users

  5. Comments

  6. Tags

  7. Media

  8. Blocks

Directives

  1. @skip and @include

  2. @default

  3. @removeIfNull

  4. @export

  5. @upperCase, @lowerCase and @titleCase

  6. @translate

  7. @traceExecutionTime

  8. @cache

Looking forward

  1. Multiple query execution

  2. Schema namespacing

  3. Nested mutations

  4. Embeddable fields

  5. Composable directives

  6. Proactive feedback

  7. Field and directive-based versioning

Using the plugin

  1. Creating a custom endpoint

  2. Creating a persisted query

  3. Creating a schema configuration

  4. Defining access control

  5. Making the API public or private

  6. Adding HTTP caching

  7. Creating an API hierarchy

Opt-in features

  1. Deprecating fields

  2. Executing multiple queries concurrently

  3. Namespacing the schema

  4. Using nested mutations

  5. Using embeddable fields

  6. Using composable directives

Configuring the plugin

  1. Browsing, enabling and disabling modules

  2. Configuring the plugin via the Settings page, environment variables, wp-config, and hooks

  3. Defining the default schema configuration

  4. Enabling granular public or private mode

  5. Setting the default cache control max-age

  6. Modifying the default and max number of results

  7. Adding a custom post type to the schema

  8. Disabling mutations

  9. Caching the GraphQL schema

  10. Enabling and configuring the single endpoint

  11. Configuring the GraphiQL client for the single endpoint

  12. Configuring the GraphiQL Explorer

  13. Configuring the Voyager client for the single endpoint

  14. Managing who can edit the schema

  15. Enabling low-level editing of persisted queries

  16. Adding a description to the API

  17. Displaying the plugin's new features

Connecting

  1. Executing queries against the GraphQL server

Recipes

  1. Strategies for API hierarchies

  2. Removing types from the schema

  3. Making directives available to the admin only

  4. Creating language-based endpoints for translating the content of the site

  5. Translating content inside blocks

Extending the GraphQL API

  1. Example of mapping the WordPress data model into a GraphQL schema

  2. Creating an extension for the GraphQL API

  3. Creating a type

  4. Creating an interface

  5. Creating a field resolver

  6. Creating a directive

  7. Creating a mutation resolver

  8. Creating a union type

  9. Creating a custom scalar

  10. Creating an enum

  11. Adding a field to all custom post types

  12. Adding more elements to the schema configuration

  13. Creating a custom access control rule

  14. Creating modules

  15. Creating persisted queries via code

  16. Restricting fields to the WordPress admin

  17. Hooking into Proactive feedback

  18. Versioning fields and directives