Homepage
Link to WPGraphQL on Github
Link to WPGraphQL on WordPress.org

Quick Start

WPGraphQL is a WordPress plugin that allows developers to interact with WordPress data using GraphQL.

This quick start guide is intended for developers that want to use GraphQL with WordPress. This guide will be most useful for developers already familiar with WordPress. If you’re brand new to WordPress, you should check out the Intro to WordPress guide.

Install

WPGraphQL is a WordPress plugin, so in order to use WPGraphQL with WordPress, it must first be installed and activated.

There are a few methods to install plugins to WordPress.

Install from your WordPress Dashboard

  1. Log in to your WordPress install
  2. From the Administration Panels, click on the Plugin Menu
  3. Under Plugins, click the “Add New” sub menu
  4. Search for “WPGraphQL”
  5. Click the “Install Now” button on the WPGraphQL plugin (should be the first one)
  6. After installation, you will find a new menu item “GraphQL” and in the top Admin Bar will be a “GraphiQL IDE” menu item.
  7. Choose your WordPress Permalink Setting. Under Settings, click Permalinks. WordPress defaults to Plain permalink structure which exposes GraphQL at /index.php?graphql. Select one of the other settings to expose GraphQL at the /graphql endpoint.

Other Install Methods

If you prefer not to install WPGraphQL from the WordPress.org repository, you can also install from GitHub or Composer.

Install with Composer

Installing plugins with Composer, a PHP dependency manager, allows you to avoid committing plugin code into your project’s version control.

WPGraphQL is available for installing with Composer from packagist.org and wpackagist.org.

The most straight forward way to install WPGraphQL with composer would be to run the following command:

This would add WPGraphQL as a dependency for your project.

The fine folks of roots.io have written more information on Using Composer with WordPress.

Download Zip from Github

Starting with the v1.2.5 release, a zip of the compiled plugin is added as a release asset to each release.

To download, navigate to the Releases page, and find the release you would like to install.

Under the “assets” section of the release will be a wp-graphql.zip file that you can download and install from your WordPress dashboard, or by adding the unzipped plugin to your WordPress wp-content/plugins directory.

Clone from Github

This install method is recommended for contributors that would like to submit pull requests to the codebase. This step assumes you have Composer installed locally, git installed locally and SSH keys setup with Github.

  1. In your command line, navigate to your WordPress plugin directory (wp-content/plugins)
  2. Run the following command git clone [email protected]:wp-graphql/wp-graphql.git
  3. This will install WPGraphQL to your plugins directory under /wp-content/plugins/wp-graphql
  4. Run the following command to install vendor dependencies: composer install. (You can also run composer install --no-dev to not install the dev dependencies needed for testing and linting).
  5. From the Administration Panels, click on the Plugin Menu
  6. WPGraphQL should now show up as a plugin.
  7. Click “Activate”

Use GraphiQL and Write your first GraphQL Query

Once WPGraphQL is installed and activated, it’s time to write your first GraphQL Query.

WPGraphQL includes a helpful tool called GraphiQL IDE, a tool that allows you to explore your GraphQL Schema end execute GraphQL Queries and Mutations.

Open GraphiQL

Open the GraphiQL IDE by clicking the “GraphiQL IDE” button in your WordPress Admin Bar.

Screenshot of the GraphiQL IDE button in the WordPress Admin Bar

This will take you to the GraphiQL IDE page.

Screenshot of GraphiQL IDE in the WordPress Dashboard

Search the Schema

Click the “Docs” button at the top right of the GraphiQL IDE.

This will expand a “Documentation Explorer” that can be used to see what Types and Fields are available in the WPGraphQL Schema.

Let’s search the Schema for something WordPress is known for: “Posts”

In the “Search Schema” field, enter the word “posts”. You should see results similar to the below screen recording.

Screen recording showing a search for "posts" in GraphiQL Docs Explorer
Screen recording showing a search for “posts” in GraphiQL Docs Explorer

Write Your First WPGraphQL Query

In the left pane, select the grayed out text and delete it.

Then paste in the following:

Then click the “Play” button to execute the query.

Your Query will be sent to your site’s WPGraphQL API endpoint and will return results that match the data that you asked for.

Screen Recording of GraphiQL IDE executing a GraphQL Query for a list of posts

Next Steps

Now that you have WPGraphQL installed and activated and have written your first query, consider some of the following guides to get more familiar with using GraphQL with WordPress: