wp-graphql/wp-graphql

GraphQL API for WordPress

v2.3.0 2025-04-28 19:57 UTC

Requires

• php: ^7.4 || ^8.0
• appsero/client: 2.0.4
• ivome/graphql-relay-php: 0.7.0
• webonyx/graphql-php: 15.20.0

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
• composer/semver: ^3.0
• dealerdirect/phpcodesniffer-composer-installer: ^1.0
• lucatume/wp-browser: <3.5
• phpcompatibility/php-compatibility: dev-develop as 9.9.9
• phpcompatibility/phpcompatibility-wp: ^2.1
• phpstan/extension-installer: ^1.1
• phpstan/phpstan: ~2.1.2
• phpstan/phpstan-deprecation-rules: ^2.0.1
• phpunit/phpunit: ^9.5
• slevomat/coding-standard: ^8.9
• szepeviktor/phpstan-wordpress: ~2.0.1
• wp-cli/wp-cli-bundle: ^2.8
• wp-graphql/wp-graphql-testcase: ^3.0

GPL-3.0-or-later

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

README

WPGraphQL

Unlock the power of WordPress data with GraphQL

WPGraphQL provides an extendable GraphQL API for any WordPress site, unlocking modern development workflows.

Whether you're a WordPress developer exploring GraphQL or a GraphQL expert diving into WordPress, WPGraphQL simplifies data interaction and empowers your development workflow.

🚀 Get Started

1. 📦 Install WPGraphQL: wp plugin install wp-graphql --activate
2. 👩‍💻 Try it out: Live Demo
3. 📖 Read the Quick Start Guide.
4. 💬 Join the Community on Discord
5. ⭐ Star the Repo on GitHub 😉

🌟 Key Features

• Flexible API: Access posts, pages, custom post types, taxonomies, users, and more.
• Extendable Schema: Easily add functionality with functions like register_graphql_field and register_graphql_connection.
  • Plugins like WPGraphQL Smart Cache, WPGraphQL for ACF and other extension plugins demonstrate the power of extendability.
• Modern Framework Integration: Works seamlessly with Next.js, Svelte, Astro and other frameworks.
• Optimized Performance: Query only the data you need. Collect multiple resources in one request, reducing round-trips. Use WPGraphQL Smart Cache for enhanced performance and network-level caching and cache-invalidation.
• Developer Tools: Explore the schema with tools like the GraphiQL IDE and WordPress Playground.

📖 Documentation

• Quick Start
• Intro to GraphQL
• Intro to WordPress
• Extensions
• Advanced Topics

🤝 Community Support

WPGraphQL is powered by a passionate community of contributors, backers, and sponsors.

Want to help maintain and grow WPGraphQL?

• Support the project on Open Collective
• Join the Community on Discord
• Contribute to the project on GitHub

🙌 Shout Outs

We extend our gratitude to the following projects and organizations for their contributions to the WordPress and GraphQL ecosystems:

• Webonyx: For the amazing graphql-php library that powers WPGraphQL's core functionality.
• Ivome: For the graphql-relay-php library used in relay connections.
• Automattic: For supporting WPGraphQL's ongoing development as a canonical WordPress plugin.
• Gatsby: For their contributions to the WPGraphQL ecosystem and support for headless WordPress development.
• WPEngine: For funding early development of WPGraphQL and supporting its growth.
• Facebook: For open-sourcing the GraphQL spec, GraphiQL, and maintaining the JavaScript reference implementation.
• Apollo: For pushing GraphQL forward and inspiring schema design best practices.
• The WordPress REST API Contributors: For paving the way with the WP-API project, inspiring WPGraphQL's architecture.

Thank you to all these organizations and individuals for their efforts in shaping the tools we rely on today.

🔌 Canonical Plugin

WPGraphQL is becoming a Canonical Plugin on WordPress.org, ensuring long-term support and a growing community of users and contributors.

🛠 Privacy & Telemetry

WPGraphQL uses the Appsero SDK to collect telemetry data only after user consent, helping us improve the plugin responsibly.