1. Home
  2. Docs
  3. Getting Started
  4. Getting Started with WPGraphQL

Getting Started with WPGraphQL


The docs are organized into sections, and each section contains related articles.

The sections and articles are organized sequentially so that you can follow them and build on things you’ve learned in earlier articles. The bottom of each article has pagination links to guide you to the next sequential article.

If you’re having trouble finding documentation for anything in particular, the header of the site contains a search box (powered by Algolia) that makes it fast and easy to discover any documentation (or other content) that you’re looking for. 

At the bottom of each article, you will see the date the article was last updated, and a feature that allows users to vote if the document was helpful or not. There’s also an option to submit a contact form if you’re still stuck. 

If there’s documentation you can’t find, feel free to submit the form on the bottom of any article explaining with as much detail and clarity as possible what you’re looking for, or file an issue on the plugin repo explaining what you’d like to see documented. 

About GraphQL

GraphQL is a spec for a Query Language for application data graphs. GraphQL isn’t tied to any specific database or storage engine and is instead backed by your existing code and data. As GraphQL is a spec, there are implementations in nearly every language, and for many different systems. 

GraphQL is centered around a strongly typed Schema. The GraphQL Schema is composed of Types, and Types are composed of fields. Fields are defined with Type that they should resolve to. Field’s can be defined as a Scalar Type (string, integer, boolean, float), or another Type.

These concepts might be hard to grasp right now, but as you continue exploring the docs, they should start to make more sense. 

How WPGraphQL brings GraphQL to WordPress 

WPGraphQL is built atop the GraphQL-PHP library and provides an executable, extendable Schema and resolvers for your WordPress site. 

WPGraphQL takes advantages of the various static registries in WordPress, such as the Post Type, Taxonomy and Settings registries to build a Schema for your WordPress site. 

GraphQL Tools and IDEs

One benefit of GraphQL is that it enables powerful developer tooling

Throughout the documentation, we will show examples of interacting with GraphQL via a GraphQL IDE, such as WPGraphiQL or GraphiQL.app

There are many GraphQL IDE tools in the wild, such as:

  • WPGraphiQL – GraphQL IDE right in your WordPress dashboard
  • GraphQL Playground – GraphQL IDE that supports multi-column schema docs, tabs, query history, configuration of HTTP headers and GraphQL Subscriptions.
  • GraphiQL.app – A light, Electron-based wrapper around GraphiQL
  • GraphQL Network – A chrome dev-tools extension for debugging GraphQL network requests.
  • GraphQL IDE – An extensive IDE for exploring GraphQL API’s
  • Altair GraphQL Client – A beautiful feature-rich GraphQL Client for all platforms
  • Insomnia – An full-featured API client with first-party GraphQL query editor

Feel free to use any of the tools mentioned, explore and discover others that aren’t mentioned, or even build your own!

Just note that guides and documentation on this site will reference WPGraphiQL and GraphiQL.app and will also make use of inline instances of the GraphiQL React component to show examples.

Was this article helpful to you? Yes 4 No 1

How can we help?