wp-graphql/wp-graphql

GraphQL API for WordPress

v1.24.0 2024-04-23 20:31 UTC

Requires

• php: ^7.1 || ^8.0
• appsero/client: 1.2.1
• ivome/graphql-relay-php: 0.7.0
• webonyx/graphql-php: 14.11.10

Requires (Dev)

• automattic/vipwpcs: ^3.0
• codeception/module-asserts: ^1.0
• codeception/module-cli: ^1.0
• codeception/module-db: ^1.0
• codeception/module-filesystem: ^1.0
• codeception/module-phpbrowser: ^1.0
• codeception/module-rest: ^1.2
• codeception/module-webdriver: ^1.0
• codeception/util-universalframework: ^1.0
• lucatume/wp-browser: <3.5
• php-coveralls/php-coveralls: ^2.5
• phpcompatibility/php-compatibility: dev-develop as 9.9.9
• phpcompatibility/phpcompatibility-wp: ^2.1
• phpstan/extension-installer: ^1.1
• phpstan/phpstan: ~1.10.18
• phpunit/phpunit: ^9.5
• slevomat/coding-standard: ^8.9
• szepeviktor/phpstan-wordpress: ~1.3.0
• wp-cli/wp-cli-bundle: ^2.8
• wp-graphql/wp-graphql-testcase: ~2.3

GPL-3.0-or-later

• Jason Bahl
• Edwin Cromley
• Ryan Kanner
• Hughie Devore
• Chris Zarate

README

WPGraphQL

WPGraphQL is a free, open-source WordPress plugin that provides an extendable GraphQL schema and API for any WordPress site.

Below are some links to help you get started with WPGraphQL

• WPGraphQL.com
• Quick Start Guide
• Intro to GraphQL
• Intro to WordPress
• Join the WPGraphQL community on Slack

Install

• Requires PHP 7.1+
• Requires WordPress 5.0+

Quick Install

Follow the WPGraphQL Quick Start instructions to install and activate WPGraphQL Details here

Additional Documentation

• Project Overview
• Plugin Usage & Extension Documentation
• Development Testing & code Coverage
• Using Docker

Shout Outs

• Special thanks to Gatsby and WPEngine for allocating development resources to push the project forward!
• This plugin brings the power of GraphQL (http://graphql.org/) to WordPress.
• The plugin is built on top of the graphql-php library by Webonyx (https://github.com/webonyx/graphql-php) and makes use of the graphql-relay-php library by Ivome (https://github.com/ivome/graphql-relay-php/)
• Some of the concepts and code are based on the WordPress Rest API. Much love to the folks (https://github.com/orgs/WP-API/people) that put their blood, sweat and tears into the WP-API project, as it's been huge in moving WordPress forward as a platform and helped inspire and direct the development of WPGraphQL.
• Much love to Facebook® for open sourcing the GraphQL spec (https://facebook.github.io/graphql/), the amazing GraphiQL dev tools (https://github.com/graphql/graphiql), and maintaining the JavaScript GraphQL reference implementation (https://github.com/graphql/graphql-js)
• Much love to Apollo (Meteor Development Group) for their work on driving GraphQL forward and providing a lot of insight into how to design GraphQL schemas, etc. Check them out: http://www.apollodata.com/

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

Privacy Policy

WPGraphQL uses Appsero SDK to collect some telemetry data upon user's confirmation. This helps us to troubleshoot problems faster & make product improvements.

Appsero SDK does not gather any data by default. The SDK only starts gathering basic telemetry data when a user allows it via the admin notice. We collect the data to ensure a great user experience for all our users.

Integrating Appsero SDK DOES NOT IMMEDIATELY start gathering data, without confirmation from users in any case.

Learn more about how Appsero collects and uses this data.