/wp-graphql

:rocket: GraphQL API for WordPress

Primary LanguagePHPGNU General Public License v3.0GPL-3.0

WPGraphQL Logo

WPGraphQL

Total Downloads Monthly Downloads Daily Downloads Latest Stable Version Actions Status Actions Status

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.
  • 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.

graphiql-ide-example.gif


📖 Documentation


🤝 Community Support

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

Backers on Open Collective Sponsors on Open Collective

Want to help maintain and grow WPGraphQL?


🙌 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.