Skip to content

Latest commit

 

History

History
113 lines (71 loc) · 8.95 KB

README.md

File metadata and controls

113 lines (71 loc) · 8.95 KB
Raw

WPGraphQL WooCommerce (WooGraphQL)

Docs • AxisTaylor • Join Slack

Automated-Testing Coding-Standards Coverage Status Financial Contributors on Open Collective

Install

Installing manually

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

Installing w/ Composer

This is the recommend way for users using unique installations like WP Bedrock or SpinupWP.

  1. Install WordPress and WooCommerce.
  2. Install WPGraphQL and WooGraphQL by running composer require wp-graphql/wp-graphql wp-graphql/wp-graphql-woocommerce
  3. Set your GraphQL client endpoint to the GraphQL endpoint of your site. Typically, this is your-store.domain/graphql. _NOTE: for typically Bedrock or SpinupWP setups it'll be your-store.domain/wp/graphql by default.

Optional extras

  • Install & activate WPGraphQL-JWT-Authentication to add a login mutation that returns a JSON Web Token.
  • Install & activate WPGraphQL-CORS to add an extra layer of security using HTTP CORS and some of WPGraphQL advanced functionality.

What can you do with this extension?

  • Query your shops products and variations with complex filtering options.
  • Query customers, orders, coupons, and refunds (*).
  • Manage a customer's session with JWTs and cart/customer queries and mutations(*).
  • Create orders manually (*), automatically with the checkout mutation, or pass a customer's session to the WooCommerce checkout page in your theme for complete payment gateway support (#).

(*) These operations have user restrictions. Please read up on authenticating an user with here, then view this React/Apollo example with the added on usage of customer session Token.

(#) This is the recommended method on checkout. You can read it's usage in this excellent write-up by @jacobarriola

Why don't the WooCommerce CPT GraphQL types support all the same features as most WordPress CPTs that WPGraphQL exposes?

The CPTs as well as most of the data objects that WooCommerce defines are wrapped in a object managers distributed by a data store system.

This data store system allows for each individual data object to be defined however needed. What this means is, although by out of the box objects like products, orders, and coupons are defined as WordPress CPTs they don't have to be.

This is what also enables WooCommerce to store most meta connected to these CPTs in separate tables. The object data doesn't even have to be in the same database if the object's data store designed to manage somewhere else, but we are getting out of the scope of this question.

What does all this ☝️ have to do with WooCommerce's CPTs' functionality? Well, the object managers distributed by the data store are WooGraphQL first point of contact for pretty much everything. Unlike the most common CPTs which use a WP_Post object as their data source and a WPGraphQL\Model\Post object as their model, WooGraphQL uses object managers as the data source for the CPTs and each individual has it's own model with it's own set of permissions and restrictions.

This has led to some friction is certain areas of the schema where WooGraphQL support is lacking. I'm sorry for the inconvience, myself and whole WPGraphQL org are working to reduce this friction and WooGraphQL properly integrated with all WPGraphQL + WPGraphQL ACF features.

Thank you for your patience @kidunot89

Future Features

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

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 🤷‍♂️

Wanna help support WooGraphQL's future

Follow alt textalt text

Demo/Examples

Who using WooGraphQL

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]