Gato GraphQL

Gato GraphQL is a powerful and flexible GraphQL server for WordPress.

Use it to expose WordPress data via GraphQL. Access any piece of data (posts, users, comments, tags, categories, etc) from your application, and also transform and mutate data.

The standard use cases are:

Code performant apps: Send a GraphQL query to your API and get exactly what you need, nothing more and nothing less.

Build dynamic/headless sites: Use WordPress as the CMS to manage data, and your framework of choice to render the site.

Speed up creating Gutenberg blocks: Ship Gutenberg blocks faster, by avoiding creating REST controllers to feed them data.

Extensions

Extensions allow you to augment the server functionality, and extend the GraphQL schema.

You can purchase each extension separately, or get a bundle containing all the extensions.

The available extensions are:

Access Control: Grant granular access to the schema (based on the user being logged-in, having some role or capability, or by IP), to manage who can access what data.

Caching: Make your application faster by providing HTTP Caching for the GraphQL response, and by caching the results of expensive operations.

Custom Endpoints: Create and expose multiple custom GraphQL schemas under their own URL, for different users, applications, external services, or other.

Deprecation: Evolve the GraphQL schema by deprecating fields, and explaining how to replace them, through a user interface.

Internal GraphQL Server: Execute GraphQL queries directly within your application, using PHP code.

Multiple Query Execution: Combine multiple queries into a single query, sharing state across them and executing them in the requested order.

Persisted Queries: Use GraphQL queries to create pre-defined endpoints as in REST, obtaining the benefits from both APIs.

Polylang Integration: Integration with the Polylang plugin, adding fields and filters to select the language when fetching data on a multilingual site.

Query Functions: Manipulate the values of fields within the GraphQL query, via a collection of utilities and special directives providing meta-programming capabilities.

Schema Functions: The GraphQL schema is provided with fields and directives which expose functionalities from the PHP programming language.

6.0.0

• Action required: When updating the plugin (i.e. not installing anew), you need to deactivate and then re-activate the plugin. Until then, the “GraphiQL” and “Schema” items won’t appear on the menu (due to the newly-added “Schema Editing Access” module, see below)
• Breaking change: Removed custom endpoints and persisted queries (#2852)
• Breaking change: The single endpoint is enabled by default (#2859)
• Breaking change: The single endpoint GraphiQL/Voyager clients are disabled default (#2860)
• Breaking change: The Schema Configuration module is disabled by default (#2848)
• Breaking change: The schema tutorial page is hidden by default (#2856)
• Breaking change: On the settings page, the configuration for items under “Schema Elements Configuration” need to be set again (#2861)
• Tested up to WordPress 6.7 (#2887)
• Do not display Endpoint Categories if there are no endpoint CPTs enabled (#2849)
• Hide “API Hierarchy” module if there are no endpoint CPTs enabled (#2850)
• Hide “Excerpt as description” module if there are no CPTs enabled (#2851)
• Display the “Enable Logs?” settings only when some extension is using it (#2853)
• Hide the Schema tutorial page by default (#2854)
• Reorganized the Settings, splitting “Schema Configuration” into 2 elements: “Schema Configuration” and “Schema Elements Configuration” (#2861)
• Improved documentation for extensions (#2866)
• Added links to online docs on the Settings page (#2875)
• Added “Schema Editing Access” module (#2877)
• [Extensions][Schema Functions] If from email not provided in _sendEmail mutation, use the blog’s admin email

5.0.0

• Breaking change: Bumped minimum WordPress version to 6.1 (#2811)
• Breaking change: Return no results when filtering data by an empty array (#2809)
• Increase limit of chars in truncated response by Guzzle (#2800)
• Added field isGutenbergEditorEnabled (#2801)
• Use isGutenbergEditorEnabled in predefined persisted queries (#2802)
• Added mutations to assign custom tags/categories to custom posts (#2803)
• Added Settings option to enable/disable logs (#2813)
• Application password failed authentication: Show error in GraphQL response (#2817)
• Added predefined persisted queries:
  • [PRO] Import post from WordPress RSS feed and rewrite its content with ChatGPT (#2818)
  • [PRO] Import new posts from WordPress RSS feed (#2819)
  • [PRO] Import HTML from URLs as new posts in WordPress (#2822)
• Support additional taxonomies for mutations on post tags/categories (not only post_tag and category) (#2823)
• Added taxonomy field also to PostTag and PostCategory types (#2824)
• Made taxonomy input not mandatory on Root.tags/categories and CustomPost.tags/categories fields (#2827)
• Fixed: Add featuredImage field on GenericCustomPost (#2806)
• Fixed: On fields blocks, blockDataItems, and blockFlattenedDataItems, avoid error when post has no content (#2814)
• Fixed: Pass mandatory attrs field when creating persisted query blocks (#3adde2e)
• [PRO] Updated mapped WordPress hooks for automation

4.2.0

• Added mutations for categories (#2764)
• Added mutations for tags (#2765)
• Validate assign_terms capability on setCategory and setTag mutations (#2772)
• Create a media item using the attachment from an existing media item (#2787)
• Added field Media.parentCustomPost (#2788)
• Added mutation Root.updateMediaItem (#2790)
• Added predefined persisted queries:
  • Create missing translation categories for Polylang (#2774)
  • Create missing translation tags for Polylang (#2774)
  • Translate categories for Polylang (#2774)
  • Translate tags for Polylang (#2774)
  • Translate categories for MultilingualPress (#2774)
  • Translate tags for MultilingualPress (#2774)
  • Create missing translation media for Polylang (#2789)
  • Translate media for Polylang (#2789)
• Added translation language mapping to persisted queries (#2775)
• Fixed exception when initializing the GraphQL Internal Server query on add_attachment (#2796)
• [PRO] Define the Polylang language on tag and category mutations
• [PRO] Automation: Store the GraphQL response in the info logs
• [PRO] Added Polylang Mutations for Media Items
• [PRO] Map additional WordPress hooks for Automation
• [PRO] Filter entities by Polylang’s default language

4.1.0

• Send the referer on Guzzle requests (#2754)
• Use @strQuoteRegex in predefined persisted queries (#2758)
• [PRO] Polylang: Filter data by language
• [PRO] Use enums types to return Polylang language codes, locales and names
• [PRO] Automation: Handle new and auto-draft old status in {$old_status}_to_{$new_status} hook (#1376)
• [PRO] Predefined automation rules: In addition to draft_to_publish, also trigger from new, auto-draft, pending, future, and private states
• [PRO] Added field _strQuoteRegex and directive @strQuoteRegex
• [PRO] Fixed: Plugin throwing exception on PHP 7.2

4.0.0

• Breaking change: Updated internal PHP hook structure for error payloads (#2739)
• Use bulk mutations in predefined persisted queries (#2728)
• Added documentation for new PRO module Polylang Mutations (#2733)
• Added documentation for new PRO field _arrayIntersect (#2735)
• Added predefined persisted query:
  • [PRO] Create missing translation posts for Polylang (#2740)
• Fixed: Don’t replace chars in translation persisted queries (#2731)
• Fixed: “Call to protected method” exception in PHP 8.2 (#2741)
• [PRO] Breaking change: Rename field _intSubstract to _intSubtract
• [PRO] Breaking change: Rename directive @intSubstract to @intSubtract
• [PRO] Breaking change: Renamed field polylangEnabledLanguages to polylangLanguages
• [PRO] Breaking change: Fields polylangLanguage, polylangDefaultLanguage and polylangLanguages return type PolylangLanguage instead of String
• [PRO] Breaking change: Renamed inputs language to languageBy and polylangLanguage to polylangLanguageBy
• [PRO] Added Polylang Mutations
• [PRO] Added field _arrayIntersect

3.0.0

• Breaking change: Require at least WordPress v6.0 (#2719)
• Breaking change: Option “Do not use payload types for mutations (i.e. return the mutated entity)” in schema configuration block “Payload Types for Mutations” must be re-selected (#2720)
• Added compatibility with WordPress 6.6 (#2717)
• Added bulk mutation fields (for all mutations in the schema) (#2721)
• Added fields to query the mutation payload objects (#2720)
• Added option to schema configuration block “Payload Types for Mutations” (#2720)
• Added predefined custom endpoint “Bulk mutations” (#2720)
• Removed predefined custom endpoint “Nested mutations + Entity as mutation payload type” (#2720)
• Fixed bug: Catch exception if dependency version is not semver (#2712)
• Fixed bug: Convert entries in JSON dictionary of variables in persisted query from array to object (#2715)

2.6.0

• Added siteURL field (#2697)
• Added fields to fetch multisite data (#2698)
• Added documentation for PRO integration with MultilingualPress (#2699)
• Added documentation for new PRO field _strRegexFindMatches (#2708)
• Added GraphQL variables $translateFromLanguage, $includeLanguagesToTranslate and $excludeLanguagesToTranslate to persisted queries (#2694 / #2700):
  • [PRO] Translate posts for Polylang (Gutenberg)
  • [PRO] Translate posts for Polylang (Classic editor)
• Added scalar types to the GraphQL schema:
  • IntValueJSONObject (#2703)
  • IDValueJSONObject (#2704)
• Added predefined persisted queries:
  • [PRO] Translate posts for MultilingualPress (Gutenberg) (#2706)
  • [PRO] Translate posts for MultilingualPress (Classic editor) (#2706)
  • [PRO] Translate Poedit file content (#2709)
• [PRO] Added integration with MultilingualPress
• [PRO] Added input valueWhenNonExistingKeyOrPath to field _objectProperty
• [PRO] Added automation rules:
  • MultilingualPress: When publishing a post, translate it to all languages (Gutenberg)
  • MultilingualPress: When publishing a post, translate it to all languages (Classic editor)
• Added Gato GraphQL intro video to documentation (#2707)
• Fixed identifying extension in createMediaItem when filename has more then one dot

2.5.2

• Fixed bug: Initialize blocks only after their corresponding CPTs (#2693)

2.5.1

• Fixed tabs in Markdown in new persisted query [PRO] Send email to users about post

2.5.0

• Added predefined persisted queries
  • [PRO] Send email to users about post (#2692)
• Added documentation for “WordPress hook mapping” for the [PRO] Automation extension (#2691)

2.4.1

• Fixed bug: Internal server error from passing string when expected int

2.4.0

• Added page mutations to the GraphQL schema (#2682)
• Added fields to fetch the logged-in user’s pages (#2682)
• Added fields to fetch the site’s locale and language (#2685)
• Install “internal” private custom endpoint (#2684)
• Support Application Passwords (#2672)
• Added documentation for new PRO field _strBase64Encode (#2673)
• Link extensions to the Extensions Reference in gatographql.com (#2675)
• Added YouTube channel link to About page (#2676)
• Added predefined persisted queries:
  • [PRO] Translate and create all pages for a multilingual site (Multisite / Gutenberg) (#2688)
  • [PRO] Translate and create all pages for a multilingual site (Multisite / Classic editor) (#2688)
• Fixed: Open GraphiQL/Voyager clients in subfolder-based Multisite network (#2677)
• Fixed: Highlight extensions and enable link to visit in website (#2674)
• Fixed: GraphiQL client (for LocalWP) now uses site URL as endpoint (#2686)

2.3.0

• Added fields GenericCustomPost.update, Root.updateCustomPost and Root.createCustomPost (#2663)
• Added documentation for integration with Polylang (#2664)
• Added module type “Integrations” (#2665)
• Return an EnumString type on GenericCategory.taxonomy and GenericTag.taxonomy (#2666)
• Fix bug: Updated the Support form’s action URL (#2662)
• Added predefined persisted queries: “[PRO] Translate posts for Polylang (Gutenberg)” (#2667), “[PRO] Translate posts for Polylang (Classic editor)” (#2667), “[PRO] Sync featured image for Polylang” (#2669) and “[PRO] Sync tags and categories for Polylang” (#2670)
• Support alternative filenames from 3rd-party plugins for extensions (#2671)
• [PRO] Added integration with Polylang
• [PRO] Added automation rules: “Polylang: When publishing a post, translate it to all languages (Gutenberg)”, “Polylang: When publishing a post, translate it to all languages (Classic editor)”, “Polylang: When publishing a post, set the featured image for each language on all translation posts” and “Polylang: When publishing a post, set the tags and categories for each language on all translation posts”

2.2.3

• Bug parsing @export(as: $someVar) (#2661)

2.2.2

• Adapted blocks field to work with WordPress 6.5 (#2657)
• Tested up WordPress 6.5
• Renamed “Tutorial” to “Schema tutorial”

2.2.1

• Added “Lesson (number): ” in the tutorials

2.2.0

• Do not include bundles in the Extensions page
• Do not print the required extensions on predefined persisted queries

2.1.3

• Added documentation for fields _arrayFlipToObject and _objectIntersectKey from the PHP Functions via Schema extension
• Added documentation for field _arrayOfJSONObjectsExtractProperty from the Helper Function Collection extension

2.1.0

• Support providing the Schema Configuration to apply when invoking the Internal GraphQL Server
• Added predefined persisted query “Insert block in post”
• If initializing the service container from the cache fails, fallback to initializing PHP object from memory (#2638)
• Give unique operationName to all predefined persisted queries (#2644)
• Improved error message when fetching blocks from a post, and the block content has errors
• Completed documentation for the Automation extension (#2651)
• On the “Generate a post’s featured image using AI and optimize it” predefined persisted query, execute logic only if the post title is not empty (#ec931dd)
• Fixed bug in multi-control JS component used by extensions (Access Control, Cache Control, and Field Deprecation) showing “undefined” on the block on the Schema Configuration (#2639)
• Fixed bug in regex replacements in predefined persisted queries (#2649)
• Avoid reinstalling plugin setup data if deactivating/reactivating the plugin (#2641)
• Handle error from passing WP_Post as GraphQL variable to the Internal GraphQL Server (#2652)

2.0.0

• Added new module Media Mutations
• Added mutation createMediaItem
• Added fields myMediaItemCount, myMediaItems and myMediaItem
• Added predefined persisted query “Generate a post’s featured image using AI and optimize it”
• Added documentation for new field _dataMatrixOutputAsCSV from the Helper Function Collection extension
• Validate the license keys when updating the plugin
• Simplified the Tutorial section
• Prevent max execution time issues when installing plugin on (cheap) shared hosting (#2631)
• Fixed bug where a syntax error on a variable definition in the GraphQL query was not validated
• Breaking change: Field resolver’s validateFieldArgValue method receives extra argument $fieldArgs

1.5.4

• Fixed bug in resolver where innerBlocks is not set

1.5.3

• Point the “Missing an extension?” link to the Contact us page
• Add link to bundles on the Extensions page
• Fixed typo in readme.txt

1.5.2

• Active bundle or extension, with different version than main plugin, did not show “Active” button in Extensions page

1.5.1

• Improved description on readme.txt (for the WordPress plugin directory)

1.5.0

• Added video to documentation for bundle
• Added new predefined persisted queries: “Send email to admin about post” and “Add comments block to post”

1.4.0

• Added predefined custom endpoint “Nested mutations + Entity as mutation payload type”
• Added “Request headers” to GraphiQL clients on single public/private endpoint, and custom endpoints
• Renamed page “Recipes” to “Tutorial”, and added settings to hide it
• Renamed existing bundles (“Application Glue & Automator” bundle => “Tailored WordPress Automator” bundle, “Content Translation” bundle => “Simplest WordPress Content Translation” bundle and “Public API” bundle => “Responsible WordPress Public API” bundle)
• Added documentation for new bundles (“Automated Content Translation & Sync for WordPress Multisite” bundle, “Better WordPress Webhooks” bundle, “Easy WordPress Bulk Transform & Update” bundle, “Private GraphQL Server for WordPress” bundle, “Selective Content Import, Export & Sync for WordPress” bundle, “Unhindered WordPress Email Notifications” bundle and “Versatile WordPress Request API” bundle)
• Fixed HTML codes were printed in select inputs in the WordPress editor, now removed

1.3.0

• Read GET variables when executing Persisted Queries via POST
• Pass data via URL params in persisted query “Register a newsletter subscriber from InstaWP to Mailchimp”
• Fixed component docs displayed in the editor were not included in the plugin

1.2.0

• Added XML scalar type
• Added documentation for new field _strDecodeXMLAsJSON from the Helper Function Collection extension
• Added documentation for new field _strParseCSV from the Helper Function Collection extension
• Added tutorial lesson “Translating content from URL”
• Added predefined Persisted Queries “Translate post (Classic editor)” and “Translate posts (Classic editor)”
• Added predefined Persisted Query “Translate content from URL”
• Added predefined Persisted Query “Import post from WordPress RSS feed”
• Added predefined Persisted Query “Import posts from CSV”
• Added predefined Persisted Query “Fetch post links”
• In predefined persisted queries “Translate post” and “Translate posts”, added failIfNonExistingKeyOrPath: false when selecting a block’s attributes.{something} property (as it may sometimes not be defined)
• In predefined persisted query “Import post from WordPress site”, added status any to select the post
• Renamed persisted query “Translate post” to “Translate post (Gutenberg)”, and “Translate posts” to “Translate posts (Gutenberg)”

1.1.1

• Fixed bug on the caching component (a downgraded reset method was called on a non array)

1.1.0

• Tested with WordPress 6.4 (“Tested up to: 6.4”)
• Install initial data: Persisted Queries for common admin tasks
• Added AnyStringScalar wildcard scalar type
• Purge container when autoupdating a depended-upon plugin

1.0.15

• Fixed: Executing introspection query failed in GraphiQL client when passing ?operationName=…

1.0.14

• Configuration alert in tutorial lesson “Duplicating multiple blog posts at once”

1.0.13

• Fixed passing dynamic variables 2 levels down
• Fixed not opening link in modal window when current page is in a modal window
• Fixed the newsletter form “action” attribute
• Added scalar type AnyScalar
• Added documentation for new field _arrayGenerateAllCombinationsOfItems from the “Helper Function Collection” extension

1.0.12

• Adapted the plugin following the assessment by the WordPress Plugin Review team.
• Recipes: Replace mysite.com with the site domain
• Added tutorial lesson: Automatically sending newsletter subscribers from InstaWP to Mailchimp

1.0.11

• The operationName param can be obtained from the URL even when doing POST

1.0.10

• Return String in fields Root.optionValue and WithMeta.metaValue

1.0

• Plugin is released! Refer to the changelog in the plugin’s repo for a thorough description of all changes