Skip to content

Back to homepage

Download
Extensions
Recipes
Guides
Pricing

Getting started

‣ Intro to GraphQL and Gato GraphQL
‣ Connecting to the GraphQL server from a client
‣ Intro to the GraphiQL client
‣ Intro to the Voyager client
‣ What is schema introspection

Special features

‣ Security
‣ Custom Endpoints
‣ Persisted Queries
‣ Public, Private & Password-Protected Endpoints
‣ Internal Endpoint for Blocks
‣ API Hierarchy
‣ Endpoint Management
‣ Schema namespacing
‣ Nested mutations
‣ Exposing “sensitive” data
‣ Global Fields
‣ Composable directives
‣ Multi-Field Directives
‣ Returning different types on mutations
‣ Field and directive-based versioning
‣ Proactive feedback
‣ Access Control
‣ Public/Private Schema
‣ HTTP Caching
‣ Multiple Query Execution
‣ Field Deprecation via UI
‣ Field to Input
‣ Function Fields
‣ Function Directives
‣ HTTP Client
‣ Schema Editing Access

Query examples

‣ Executing Queries and Mutations
‣ Posts
‣ Custom Posts
‣ Blocks
‣ Pages
‣ Users
‣ Comments
‣ Post Tags
‣ Post Categories
‣ Custom Tags
‣ Custom Categories
‣ Media
‣ Meta Values
‣ Menus
‣ Settings
‣ Directives

Creating an API

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

Configuring the schema

‣ Namespacing the schema
‣ Adding custom headers to the GraphQL response (CORS)
‣ Using nested mutations
‣ Querying “sensitive” data fields
‣ Querying 'self' fields
‣ Making the API public or private
‣ Executing multiple queries concurrently
‣ Deprecating fields
‣ Using composable directives
‣ Using "field to input"

Configuring the plugin

‣ Installing and upgrading a bundle or extension
‣ Browsing, enabling and disabling modules
‣ Configuring the plugin via the Settings page, environment variables, wp-config, and hooks
‣ Defining the default schema configuration
‣ Defining the schema configuration for the Internal GraphQL Server
‣ Modifying the default and max number of results
‣ Allowing access to Custom Post Types
‣ Resolving CustomPostUnion to a single type
‣ Adding a custom tag taxonomy to the schema
‣ Adding a custom category taxonomy to the schema
‣ Defining the allow/denylist for meta values
‣ Returning a payload object or the mutated entity for mutations
‣ Defining the Setting's allowed entries
‣ Enabling and configuring the single endpoint
👉🏽 Configuring custom endpoints
‣ Configuring the GraphiQL client for the single endpoint
‣ 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
‣ Creating Custom Internal Endpoints for Blocks
‣ Managing who can edit the schema
‣ Enabling granular public or private mode
‣ Removing types from the schema
‣ Removing fields and directives from the schema
‣ Disabling mutations
‣ Restricting access by user login state, role or capability
‣ Restricting access by visitor IP
‣ Setting the default cache control max-age
‣ Configuring what environment variables and PHP constants can be queried
‣ Configuring what URLs can be HTTP-requested
‣ Hiding Global Fields
‣ Disabling introspection
‣ Enabling low-level editing of persisted queries

Schema augmentation

‣ Schema extensions via introspection
‣ 'oneOf' Input Object
‣ 'Enum String' types
‣ Dynamic variables
‣ Output extensions

Interacting with the GraphQL API

‣ Working with Custom Posts
‣ Working with Custom Tags
‣ Working with Custom Categories
‣ Working with Meta Values
‣ Working with (Gutenberg) blocks
‣ Handling mutation payloads
‣ Security: Avoid exposing credentials used in the query
‣ Changing the path to where a field is printed in the response

Concepts, Ideas, Strategies

‣ Fetching dynamically-structured data
‣ Explaining nested mutations
‣ Namespacing the schema to avoid conflicts
‣ Designing the application to work with different GraphQL servers
‣ Use cases for multiple custom endpoints
‣ Evolving the schema via field versioning
‣ Use cases for versioning fields and directives
‣ Strategies for versioning fields and directives
‣ Strategies for API hierarchies
‣ How the plugin maps the WordPress data model into the GraphQL schema
‣ Similarities between WordPress hooks and GraphQL directives
‣ Mapping the GraphQL Schema for your WordPress site, theme or plugin
‣ Comparing field arguments and directives
‣ Authorization via access control
‣ Cache control via persisted queries
‣ Scripting capabilities via meta directives

Resources

‣ GraphQL best practices
‣ GraphQL clients

Configuring custom endpoints

The custom endpoint base URL path is graphql by default. This value can be modified through the Settings, on tab "Custom Endpoints":

Custom endpoints in Settings

Enabling and configuring the single endpoint Configuring the GraphiQL client for the single endpoint

Browse more guides

Getting started

‣ Intro to GraphQL and Gato GraphQL
‣ Connecting to the GraphQL server from a client
‣ Intro to the GraphiQL client
‣ Intro to the Voyager client
‣ What is schema introspection

Special features

‣ Security
‣ Custom Endpoints
‣ Persisted Queries
‣ Public, Private & Password-Protected Endpoints
‣ Internal Endpoint for Blocks
‣ API Hierarchy
‣ Endpoint Management
‣ Schema namespacing
‣ Nested mutations
‣ Exposing “sensitive” data
‣ Global Fields
‣ Composable directives
‣ Multi-Field Directives
‣ Returning different types on mutations
‣ Field and directive-based versioning
‣ Proactive feedback
‣ Access Control
‣ Public/Private Schema
‣ HTTP Caching
‣ Multiple Query Execution
‣ Field Deprecation via UI
‣ Field to Input
‣ Function Fields
‣ Function Directives
‣ HTTP Client
‣ Schema Editing Access

Query examples

‣ Executing Queries and Mutations
‣ Posts
‣ Custom Posts
‣ Blocks
‣ Pages
‣ Users
‣ Comments
‣ Post Tags
‣ Post Categories
‣ Custom Tags
‣ Custom Categories
‣ Media
‣ Meta Values
‣ Menus
‣ Settings
‣ Directives

Creating an API

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

Configuring the schema

‣ Namespacing the schema
‣ Adding custom headers to the GraphQL response (CORS)
‣ Using nested mutations
‣ Querying “sensitive” data fields
‣ Querying 'self' fields
‣ Making the API public or private
‣ Executing multiple queries concurrently
‣ Deprecating fields
‣ Using composable directives
‣ Using "field to input"

Configuring the plugin

‣ Installing and upgrading a bundle or extension
‣ Browsing, enabling and disabling modules
‣ Configuring the plugin via the Settings page, environment variables, wp-config, and hooks
‣ Defining the default schema configuration
‣ Defining the schema configuration for the Internal GraphQL Server
‣ Modifying the default and max number of results
‣ Allowing access to Custom Post Types
‣ Resolving CustomPostUnion to a single type
‣ Adding a custom tag taxonomy to the schema
‣ Adding a custom category taxonomy to the schema
‣ Defining the allow/denylist for meta values
‣ Returning a payload object or the mutated entity for mutations
‣ Defining the Setting's allowed entries
‣ Enabling and configuring the single endpoint
👉🏽 Configuring custom endpoints
‣ Configuring the GraphiQL client for the single endpoint
‣ 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
‣ Creating Custom Internal Endpoints for Blocks
‣ Managing who can edit the schema
‣ Enabling granular public or private mode
‣ Removing types from the schema
‣ Removing fields and directives from the schema
‣ Disabling mutations
‣ Restricting access by user login state, role or capability
‣ Restricting access by visitor IP
‣ Setting the default cache control max-age
‣ Configuring what environment variables and PHP constants can be queried
‣ Configuring what URLs can be HTTP-requested
‣ Hiding Global Fields
‣ Disabling introspection
‣ Enabling low-level editing of persisted queries

Schema augmentation

‣ Schema extensions via introspection
‣ 'oneOf' Input Object
‣ 'Enum String' types
‣ Dynamic variables
‣ Output extensions

Interacting with the GraphQL API

‣ Working with Custom Posts
‣ Working with Custom Tags
‣ Working with Custom Categories
‣ Working with Meta Values
‣ Working with (Gutenberg) blocks
‣ Handling mutation payloads
‣ Security: Avoid exposing credentials used in the query
‣ Changing the path to where a field is printed in the response

Concepts, Ideas, Strategies

‣ Fetching dynamically-structured data
‣ Explaining nested mutations
‣ Namespacing the schema to avoid conflicts
‣ Designing the application to work with different GraphQL servers
‣ Use cases for multiple custom endpoints
‣ Evolving the schema via field versioning
‣ Use cases for versioning fields and directives
‣ Strategies for versioning fields and directives
‣ Strategies for API hierarchies
‣ How the plugin maps the WordPress data model into the GraphQL schema
‣ Similarities between WordPress hooks and GraphQL directives
‣ Mapping the GraphQL Schema for your WordPress site, theme or plugin
‣ Comparing field arguments and directives
‣ Authorization via access control
‣ Cache control via persisted queries
‣ Scripting capabilities via meta directives

Subscribe to our newsletter

Receive timely updates on new releases, documentation, extensions, and more.

Your email:

Back to homepage

Gato GraphQL

Interact with all your data in WordPress

Download
Extensions
Recipes
Guides
Pricing

Recipe List
Guide List

Blog
Newsletter

My Orders
Launch live demo↗

Request an Extension↗
GitHub↗

Affiliate Program↗
Contact Us