Guides

📣 We are working on the remaining guides. Subscribe to our 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 and mutating data

  1. Posts

  2. Custom Posts

  3. Pages

  4. Users

  5. Comments

  6. Tags

  7. Categories

  8. Media

  9. Menus

  10. Settings

  11. Blocks

Directives

  1. @skip and @include

  2. @default

  3. @removeIfNull

  4. @export

  5. @upperCase, @lowerCase and @titleCase

  6. @cache

  7. @traceExecutionTime

  8. @translate

Looking forward

  1. Schema namespacing

  2. Nested mutations

  3. Field and directive-based versioning

  4. Multiple query execution

  5. Embeddable fields

  6. Composable directives

  7. Proactive feedback

Creating an API

  1. Creating a custom endpoint

  2. Creating a persisted query

  3. Creating a schema configuration

  4. Defining access control

  5. Adding HTTP caching

  6. Creating an API hierarchy

Configuring the schema

  1. Namespacing the schema

  2. Using nested mutations

  3. Querying 'unrestricted' fields

  4. Making the API public or private

  5. Executing multiple queries concurrently

  6. Deprecating fields

  7. Using composable directives

  8. Using embeddable fields

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. Defining the allow/denylist for meta values

  9. Disabling mutations

  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. Enabling low-level editing of persisted queries

  15. Adding a description to the API

  16. Displaying the plugin's new features

  17. Printing the Settings page with tabs or long format

  18. Defining the Setting's allowed entries

  19. Caching the GraphQL schema

  20. Managing who can edit the schema

Connecting

  1. Executing queries against the GraphQL server

Recipes

  1. Strategies for API hierarchies

  2. Removing types from the schema

  3. Security considerations when exposing data in a live API

  4. Making directives available to the admin only

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

  6. 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

  19. Removing fields from the schema, via hooks

  20. Restricting access to Custom endpoints and Persisted queries, by code