wp-graphql/wp-graphql-woocommerce

WooCommerce bindings for WPGraphQL

v0.21.0 2024-08-07 16:54 UTC

Requires

• php: >=7.3
• firebase/php-jwt: ^6.1.0

Requires (Dev)

• axepress/wp-graphql-cs: ^2.0.0-beta
• axepress/wp-graphql-stubs: ^1.27.1
• php-stubs/woocommerce-stubs: 9.1.0
• phpstan/extension-installer: ^1.3
• phpstan/phpdoc-parser: ^1.22.0
• phpstan/phpstan: ^1.10
• szepeviktor/phpstan-wordpress: ^1.3

GPL-3.0-or-later

• Geoff Taylor

• api
• wordpress
• woocommerce
• graphql
• wp-graphql
• wp-graphql-extension
• woocommerce-extension
• woographql

README

WPGraphQL for WooCommerce

Website • Docs • Schema • Playground • About • Join Slack

Install

Installing Manually

1. Install and activate WPGraphQL and WooCommerce.
2. Download the wp-graphql-woocommerce.zip file from the Assets section of the most stable release and activate the plugin in your WordPress directory.
3. Set your GraphQL client endpoint to your site's GraphQL endpoint. Typically, this is your-store.domain/graphql.

Installing with Composer

This method is recommended for users with unique installations like WP Bedrock or SpinupWP.

1. Install WordPress and WooCommerce.
2. Install WPGraphQL and WPGraphQL for WooCommerce by running composer require wp-graphql/wp-graphql wp-graphql/wp-graphql-woocommerce.
3. Set your GraphQL client endpoint to your site's GraphQL endpoint. For typical Bedrock or SpinupWP setups, the default will be your-store.domain/wp/graphql.

Optional Extras

• Install & activate WPGraphQL-JWT-Authentication to introduce a login mutation that returns a JSON Web Token.
• Install & activate WPGraphQL Headless Login to introduce a login mutation with OAuth2 client support. Shouldn't be used with WPGraphQL-JWT-Authentication
• Install & activate WPGraphQL-CORS for enhanced security via HTTP CORS and to utilize some advanced WPGraphQL features.

What Can You Do with This Extension?

• Query your shop's products and variations with detailed filtering options.
• Query customers, orders, coupons, and refunds. Note: Operations have user restrictions.
• Manage customer sessions using JWTs, and use cart/customer queries and mutations. Note: Operations have user restrictions.
• Manually create orders, automate order creation with the checkout mutation, or delegate a customer's session to the WooCommerce checkout page in your theme for comprehensive payment gateway support.

(*) These operations have user restrictions. Learn how to utilize them correctly at the resources listed below:

• Authentication and Authorization
• Configuring a GraphQL Client for WooCommerce User Session Management
• Handling User Authentication
• Handling User Session and Using Cart Mutations
• Using Checkout Mutation and Order Mutations
• Using Order Data

(#) The recommended method to checkout, taking full advantage of WooCommerce's payment gateways for payment process and other checkout-related extenstions, is to pass the session back to the WordPress installation and let WooCommerce take over from the tradition checkout page. Learn more about this approach below.

• Harmonizing with WordPress
• Hosted WooCommerce Checkout for a Headless Application

Alternatively, you can create a custom checkout form and process payments externally. Here is some resources for that as well.

• Headless WooCommerce Checkout with Gatsby and Stripe

Why Don't WooCommerce CPT GraphQL Types Support All the Features WPGraphQL Exposes for Most WordPress CPTs?

WooCommerce's Custom Post Types (CPTs) and most data objects are managed by a data store system. This system allows for flexible data object definitions. While objects like products, orders, and coupons are defined as WordPress CPTs by default, they don't have to be.

This flexibility also lets WooCommerce store metadata for these CPTs in separate tables, and the data doesn't necessarily have to reside in the same database.

The data store system and its object managers are WooGraphQL's primary contact points. Unlike standard CPTs, which use a WP_Post object for data sourcing and a WPGraphQL\Model\Post object for modeling, WPGraphQL for WooCommerce engages object managers for its data source. Each object type has a unique model with distinct permissions and restrictions.

Such a setup has resulted in some disparities between the schema where WPGraphQL for WooCommerce support might be lacking. We apologize for any inconvenience. Both I and the entire WPGraphQL team are actively working to harmonize WPGraphQL for WooCommerce with all WPGraphQL and WPGraphQL ACF features.

Thank you for your patience 😄 @kidunot89

Future Features

• Product CRUD mutations.
• And some other stuff I'm sure 🤔

For WooCommerce Extensions Support

WooGraphQL Pro is an extension of WPGraphQL for WooCommerce that provides compatibility with a variety of popular WooCommerce extensions. This compatibility empowers you to leverage these extensions within the context of the GraphQL API, thereby enabling you to build more dynamic and powerful headless eCommerce applications.

The following WooCommerce extensions are supported by WooGraphQL Pro:

• WooCommerce Subscriptions
• WooCommerce Product Bundles
• WooCommerce Product Add-Ons
• WooCommerce Composite Products

Installing Supported WooCommerce Extensions (Optional)

If you wish to use any of the supported WooCommerce extensions with WooGraphQL Pro, follow these steps:

1. Purchase your desired extensions from the WooCommerce marketplace. The supported extensions are listed above.
2. Download the .zip file(s) for your purchased extension(s) from your WooCommerce account.
3. In your WordPress Admin Dashboard, navigate to Plugins > Add New > Upload Plugin, and upload the downloaded .zip file(s).
4. Once the upload is complete, click on 'Activate Plugin' to activate the extension(s).

Installing and Activating WooGraphQL Pro

To install and activate WooGraphQL Pro, follow these steps:

1. Purchase WooGraphQL Pro from our official website.
2. After purchase you should find yourself on your account dashboard. Go to the Licenses page and generate and new license and copy it for later.
3. Next go to the Downloads page and download the latest version of WooGraphQL Pro.
4. Go to your WordPress Admin Dashboard, navigate to Plugins > Add New > Upload Plugin, and upload the woographql-pro.zip file you downloaded.
5. After uploading, click 'Activate Plugin' to activate WooGraphQL Pro.

Enabling Schema Support for Installed Extensions

To enable schema support for your installed extensions, follow these steps:

1. Navigate to the WPGraphQL settings page on your WordPress Admin Dashboard.
2. Click on the 'WooGraphQL' tab.
3. Here, you'll find a list of WPGraphQL for WooCommerce configuration options. Go below to the WooGraphQL Pro section and paste in license and check the boxes next to your installed extensions to enable schema support for them.

Note: The 'Enable Unsupported Product Type' option can be found on the same settings tab. If you enable this option, any product type without a proper GraphQL type will default to the UnsupportedProduct type, which is identical to the SimpleProduct type. With this type, the client can use the metaData field to get a string representation of the meta data on the type. This could potentially be all that's needed for simpler product types.

With WooGraphQL Pro and your chosen extensions now installed, you're ready to build more sophisticated, feature-rich eCommerce solutions with WordPress and WooCommerce.

Development Tools

Playground

Feel free to test out the extension using this GraphiQL Playground. The playground allows you to execute queries and mutations, as well as view the schema (*).

(*) I have a tendency to forget to update the playground between releases 😅, so if you believe this to be the case look me up somewhere on this page and lemme know 🤷‍♂️

create-woonext-app CLI and @woographql packages

Designed to both streamline development for individuals and teams looking to utilize WooCommerce + WooCommerce extensions in larger project and not waste too much to much time on the particulars of WPGraphQL for WooCommerce like session management or checkout, the create-woonext-app CLI generates a pre-created e-commerce application on Next.js application tailored to the developer/team.

npx create-woonext-app <license> [options]

The generated application utilizes the @woographql packages exclusive to the unlimited/annual subscribers of WooGraphQL Pro. So Go Subscribe! 😄. Below are more resources on the create-woonext-app CLI and @woographql packages.

• create-woonext-app Homepage
• create-woonext-app on NPM: The create-woonext-app README with more CLI usage instructions.
• create-woonext-app Live Demo: fully decked out putting all current possible functionalities of the create-woonext-app on full display.
• @woographql/next README: A Template generator CLI. Capable of generator a multitude of Next.js pages, Next.js Route Handlers, react components, react hooks, and utilities. It's also equipped to generate react component and hook stubs for speedy component create with no boilerplate.
• @woographql/react-hooks README: React hook library acting as the backbone for UI connected to session, cart, and customer.
• @woographql/session-utils README: Provides utilities for managing the WPGraphQL + WPGraphQL for WooCommerce session tokens like a TokenManager, also provides interfaces and types for easy customization of said TokenManager or the complete creation of a custom TokenManager with minimal effort. The bundled TokenManager implemented utilizes browser storage (Local/Session storage), so if you'd prefer something like Iron Session this might be the route for you.
• @woographql/codegen README: A convenient wrapper for GraphQL Codegen providing a few configurations out of the box, with the ability to override the default configuration by creating a codegen.ts in the project root.

Wanna help support WooGraphQL's future

• Sponsor @kidunot89 (WPGraphQL for WooCommerce Creator/Developer) on Github
• Sponsor WooGraphQL on OpenCollective
• Sponsor WPGraphQL on OpenCollective
• Sponsor GraphQL-PHP on OpenCollective
• Or Contribute

Follow

Demo/Examples

• Examples with Next.js
  • WPGraphQL for WooCommerce Demo
  • Next.js WooCommerce Theme [source] [demo video]
• Examples with Gatsby
  • Gatsby WooCommerce Theme [source] [demo video]
• Examples with WooGraphQL Pro [homepage]
  • create-woonext-app CLI Demo [homepage] [docs]
  • WPGraphQL for WooCommerce homepage

Who using it?

Contributors

Code Contributors

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

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

Disclaimer: WPGraphQL for WooCommerce is an open-source WordPress plugin and WooCommerce extension developed and maintained by Geoff Taylor, licensed under GPLv3. It is not owned, maintained, or affiliated with Automattic or WooCommerce.