What developers can build on: hooks, shortcodes, blocks, REST routes and WP-CLI commands, taken from each plugin’s own readme and from what this site has registered.<\/p>\n\n\n\n
[drx_mtm_account]<\/code>, [drx_mtm_picker]<\/code>, [drx_mtm_checkout]<\/code>, [drx_mtm_order]<\/code>, [drx_mtm_price_table]<\/code><\/li>- Blocks:<\/strong>
doctorx-commerce\/picker<\/code><\/li>- REST routes:<\/strong>
\/doctorx-commerce\/v1<\/code>, \/doctorx-commerce\/v1\/cart<\/code>, \/doctorx-commerce\/v1\/cart\/add<\/code>, \/doctorx-commerce\/v1\/cart\/line<\/code>, \/doctorx-commerce\/v1\/cart\/clear<\/code>, \/doctorx-commerce\/v1\/cart\/code<\/code>, \/doctorx-commerce\/v1\/quote<\/code>, \/doctorx-commerce\/v1\/order<\/code>, \/doctorx-commerce\/v1\/paypal\/create<\/code>, \/doctorx-commerce\/v1\/paypal\/capture<\/code>, \/doctorx-commerce\/v1\/paypal\/webhook<\/code><\/li><\/ul>\n\n\n\nEvery function below is defined only when no other plugin defines it: check function_exists()<\/code> first, because this plugin may be switched off. DOCTORX_COMMERCE_VERSION<\/code> holds the version. Money is in cents (integers) unless stated; sizes are in base units (eighths of an inch for inch products, millimetres for centimetre products); dates are UTC.<\/p>\nOrders<\/h3>\n\ndoctorx_commerce_get_order( $id_or_reference )<\/code> returns an order or null: id<\/code>, reference<\/code>, status<\/code>, status_label<\/code>, created_at<\/code>, paid_at<\/code> (ISO 8601, UTC), customer<\/code> (user_id<\/code>, name<\/code>, email<\/code>, phone<\/code>, address_1<\/code>, address_2<\/code>, city<\/code>, province<\/code>, postal<\/code>, country<\/code>), fulfilment<\/code> (ship<\/code> or pickup<\/code>), tax_province<\/code>, currency<\/code>, subtotal_cents<\/code> (before the discount), shipping_cents<\/code>, fee_cents<\/code>, discount_code<\/code>, discount_cents<\/code>, tax_cents<\/code>, taxes<\/code> (label<\/code>, type<\/code>, rate<\/code> in thousandths of a percent, cents<\/code>), total_cents<\/code>, paid_cents<\/code>, refunded_cents<\/code>, payment_method<\/code>, items<\/code> (product_id<\/code>, title<\/code>, sku<\/code>, size_text<\/code>, area_text<\/code>, width<\/code>, height<\/code>, unit<\/code>, material_id<\/code>, material_name<\/code>, options<\/code>, label<\/code>, qty<\/code>, each_cents<\/code>, line_cents<\/code>, discount_cents<\/code> (the line's share of the discount)), meta<\/code>, view_url<\/code> (the customer's private link), admin_url<\/code>.<\/li>\ndoctorx_commerce_get_orders( array $args )<\/code>: status<\/code> (a status or a list), email<\/code>, user_id<\/code>, search<\/code>, since<\/code>, until<\/code> (UTC "Y-m-d H:i:s"), limit<\/code> (default 50, at most 500), offset<\/code>. Newest first.<\/li>\ndoctorx_commerce_get_customer_orders( $user_id_or_email, array $args )<\/code>.<\/li>\ndoctorx_commerce_order_statuses()<\/code>: pending<\/code> (Awaiting payment), review<\/code> (Payment needs review), paid<\/code>, in_production<\/code>, shipped<\/code>, ready<\/code> (Ready for pickup), delivered<\/code>, cancelled<\/code>, refunded<\/code>.<\/li>\ndoctorx_commerce_set_order_status( $order_id, $status, $note )<\/code>: moves an order the way the order screen would; paid<\/code> and refunded<\/code> come only from a payment or a refund.<\/li>\ndoctorx_commerce_get_order_meta( $order_id, $key )<\/code> and doctorx_commerce_update_order_meta( $order_id, $key, $value )<\/code> (null removes it): small values of your own on an order.<\/li>\ndoctorx_commerce_order_url( $order_id )<\/code>: the customer's private link.<\/li>\n<\/ul>\nProducts, prices and the cart<\/h3>\n\ndoctorx_commerce_get_products( array( 'status' => 'publish' ) )<\/code> returns one array per product that has a price. Always: id<\/code>, price<\/code> (float, dollars: the "From" price the product page and its structured data show, for one item at the example size with the cheapest material and required options, before tax; send this to shopping feeds so the feed matches the page), price_from<\/code> (the lowest price at the smallest size), currency<\/code>, in_stock<\/code> (true while the store is open and the product is published; filter doctorx_commerce_product_in_stock<\/code>). Also price_cents<\/code>, sku<\/code>, title<\/code>, description<\/code>, url<\/code>, image_url<\/code>, gallery<\/code> (image URLs), categories<\/code> (names), brand<\/code> (the business name), mpn<\/code> (the SKU) and material<\/code> (names joined with "\/"). Arguments: status<\/code> (a status or a list), ids<\/code>, limit<\/code>. doctorx_commerce_get_product( $id )<\/code> returns one.<\/li>\ndoctorx_commerce_get_product_config( $product_id )<\/code>, without prices: mode<\/code> (area<\/code> or fixed<\/code>), unit<\/code> (in<\/code> or cm<\/code>), min_w<\/code>, max_w<\/code>, min_h<\/code>, max_h<\/code>, example_w<\/code>, example_h<\/code> (base units), max_qty<\/code>, label_field<\/code>, materials<\/code> (swatch id => name), groups<\/code> (each id<\/code>, label<\/code>, required<\/code>, show_if<\/code> (array( group, choice ) or null), choices<\/code> (id => label)).<\/li>\ndoctorx_commerce_quote( $product_id, array $config )<\/code>: the server's price for width<\/code>, height<\/code>, material<\/code>, options<\/code> (group => choice), qty<\/code>; returns each_cents<\/code>, line_cents<\/code> and the description, or a WP_Error with a message per field.<\/li>\ndoctorx_commerce_cart_add( array $item )<\/code> (product<\/code>, width<\/code>, height<\/code>, material<\/code>, options<\/code>, qty<\/code>, label<\/code>) returns true or a WP_Error; doctorx_commerce_cart_clear()<\/code>; doctorx_commerce_cart_url()<\/code> (the checkout page); doctorx_commerce_account_url()<\/code>.<\/li>\ndoctorx_commerce_money( $cents )<\/code>: a price in the store's currency, as the shop prints it.<\/li>\ndoctorx_commerce_cart_totals( array( 'province' => 'ON', 'fulfilment' => 'ship' ) )<\/code>: the current visitor's cart priced as the checkout shows it (the REST GET cart<\/code> figures: subtotal_cents<\/code>, discount_cents<\/code>, shipping_cents<\/code>, tax_cents<\/code>, total_cents<\/code>, lines).<\/li>\ndoctorx_commerce_store_is_public()<\/code>: true when the store is open to the public. While it is open to staff only (or off), this plugin's Checkout, Order status and My account pages are private; a plugin that makes its own shop pages can keep them private too and publish them on doctorx_commerce_store_opened<\/code>.<\/li>\ndoctorx_commerce_payment_methods( $ready_only = true )<\/code>: id => label of the ways to pay the current visitor is offered (etransfer<\/code>, bank<\/code>, cheque<\/code>, delivery<\/code>, paypal<\/code>, and account<\/code> when a plugin offers it), or every method the store knows with false. Every method except paypal<\/code> is offline: the shop marks the order paid by hand.<\/li>\n<\/ul>\nPayment on account<\/h3>\n
The account<\/code> method ("On account (invoice)") is never offered to ordinary shoppers. Offer it to a customer by adding it in the doctorx_commerce_payment_methods<\/code> filter, for example for approved trade customers:<\/p>\nadd_filter( 'doctorx_commerce_payment_methods', function ( $methods, $ready_only ) {\n if ( $ready_only && my_customer_may_pay_on_account( get_current_user_id() ) ) {\n $methods['account'] = true; \/\/ or array( 'label' => ..., 'note' => ... )\n }\n return $methods;\n}, 10, 2 );<\/code><\/pre>\nSuch an order is placed as "Awaiting payment" with its order number as the invoice reference, and the shop marks it paid on the order screen, like an e-Transfer.<\/p>\n
Actions<\/h3>\n\ndoctorx_commerce_order_placed<\/code> ( $order_id, $order ): an order was placed (not yet paid).<\/li>\ndoctorx_commerce_order_paid<\/code> ( $order_id, $order ): paid in full (a verified PayPal capture, or an offline payment marked received). Fires once per order.<\/li>\ndoctorx_commerce_order_status_changed<\/code> ( $order_id, $status, $old_status, $order, $note ).<\/li>\ndoctorx_commerce_order_delivered<\/code> ( $order_id, $order ): delivered or collected (for example, to ask for a review).<\/li>\ndoctorx_commerce_order_cancelled<\/code> ( $order_id, $order ).<\/li>\ndoctorx_commerce_order_refunded<\/code> ( $order_id, $cents, $order ).<\/li>\ndoctorx_commerce_payment_mismatch<\/code> ( $order_id, $detail, $facts ): a payment did not match its order; it was left unpaid and marked for review.<\/li>\ndoctorx_commerce_product_changed<\/code> ( $product_id ): a product's details, prices, materials or availability changed; 0 means every product (a store-wide setting such as the currency or the store switch changed).<\/li>\ndoctorx_commerce_before_picker<\/code> ( $product_id ): print above the picker and its prices.<\/li>\ndoctorx_commerce_product_after_summary<\/code> ( $product_id ): print after the picker on a product's own page (reviews, ratings).<\/li>\ndoctorx_commerce_account_top<\/code> ( $user ): print at the top of a signed-in customer's account page.<\/li>\ndoctorx_commerce_store_opened<\/code>: the store has just been opened to the public (fires once per opening).<\/li>\n<\/ul>\nFilters<\/h3>\n\ndoctorx_commerce_pricing_rules<\/code> ( $rules, $product_id ): change a product's rules (for example trade prices). The picker preview, the cart, the checkout and the order all read the filtered rules, so they always agree. Money in cents: lines<\/code> (base<\/code>, rate<\/code>), price<\/code> (fixed products), groups[].choices[]<\/code> (add<\/code>, add_rate<\/code>).<\/li>\n