TOC

Mike Jolley 2017-06-05 09:59:19 +01:00
parent 45c0aabec4
commit e589dcc806
9 changed files with 91 additions and 0 deletions

@ -5,6 +5,22 @@
- [What is WP-CLI?](#what-is-wp-cli)
- [WooCommerce Commands](#woocommerce-commands)
- [Examples](#examples)
- [Command:](#command)
- [Response:](#response)
- [Command:](#command-1)
- [Response:](#response-1)
- [Command:](#command-2)
- [Response:](#response-2)
- [Command:](#command-3)
- [Response:](#response-3)
- [Command:](#command-4)
- [Response:](#response-4)
- [Command:](#command-5)
- [Response:](#response-5)
- [Command:](#command-6)
- [Response:](#response-6)
- [Command:](#command-7)
- [Response:](#response-7)
- [Frequently Asked Questions](#frequently-asked-questions)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->

@ -1,3 +1,15 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
## Table of Contents
- [About the WooCommerce REST API](#about-the-woocommerce-rest-api)
- [API Versioning and how it affects development](#api-versioning-and-how-it-affects-development)
- [Adding new endpoints](#adding-new-endpoints)
- [Schema first development](#schema-first-development)
- [Deprecation of older versions](#deprecation-of-older-versions)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
## About the WooCommerce REST API
WooCommerce is fully integrated with the [WordPress REST API](https://developer.wordpress.org/rest-api/). This allows WooCommerce data to be created, read, updated, and deleted using requests in JSON format and using various WordPress REST API Authentication methods with standard HTTP verbs which are understood by most HTTP clients.

@ -1,3 +1,12 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
## Table of Contents
- [General CSV guidelines](#general-csv-guidelines)
- [CSV columns and formatting](#csv-columns-and-formatting)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
This is the schema used for the built in [CSV importer and exporter](https://github.com/woocommerce/woocommerce/wiki/Product-CSV-Importer-&-Exporter) in WooCommerce 3.1+.
## General CSV guidelines

@ -1,3 +1,19 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
## Table of Contents
- [Overview](#overview)
- [Importer](#importer)
- [Upload CSV File Screen](#upload-csv-file-screen)
- [Mapping Screen](#mapping-screen)
- [Importing screen](#importing-screen)
- [Adding Custom Import Columns (Developers)](#adding-custom-import-columns-developers)
- [Exporter](#exporter)
- [Adding Custom Export Columns (Developers)](#adding-custom-export-columns-developers)
- [Support & Bugs](#support--bugs)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
## Overview
Starting in version 3.1.0, WooCommerce has a built-in product CSV importer and exporter. You can easily import, export, and update hundreds or thousands of products on your WooCommerce sites. The importer and exporter support all types of products, including variations. This guide will walk you through using the importer and exporter and will also detail how to add custom import and export columns for developers.

@ -1,3 +1,14 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
## Table of Contents
- [Possible causes](#possible-causes)
- [Finding a JavaScript error](#finding-a-javascript-error)
- [Finding the conflict](#finding-the-conflict)
- [Resolving the conflict](#resolving-the-conflict)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
If you see something like this on product and coupon edit pages you may have a Select2 conflict or JavaScript error:
![](https://cloud.githubusercontent.com/assets/27859664/25281923/8ab71cf0-2674-11e7-883d-c360240841bf.png)

@ -8,6 +8,7 @@
- [Connection issues with localhost and self signed SSL certificates](#connection-issues-with-localhost-and-self-signed-ssl-certificates)
- [401 Unauthorized](#401-unauthorized)
- [Consumer key is missing](#consumer-key-is-missing)
- [Server does not support POST/DELETE/PUT](#server-does-not-support-postdeleteput)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->

@ -3,6 +3,7 @@
## Table of Contents
- [Virtual orders do not have shipping addresses](#virtual-orders-do-not-have-shipping-addresses)
- [`get_qty_refunded_for_item` handling](#get_qty_refunded_for_item-handling)
- [set_payment_method does not update meta values](#set_payment_method-does-not-update-meta-values)
- [Data filters differ when extending classes with a different object type](#data-filters-differ-when-extending-classes-with-a-different-object-type)
- [Notification email sending](#notification-email-sending)

@ -1,3 +1,11 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
## Table of Contents
- [Disabling gallery features](#disabling-gallery-features)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
The new gallery introduced in 3.0.0 ([read here for more information](https://woocommerce.wordpress.com/2016/10/19/new-product-gallery-merged-in-to-core-for-2-7/)) uses Flexslider, Photowipe, and the jQuery Zoom plugin to offer swiping, lightboxes and other neat features.
This new gallery is off by default for custom and 3rd party themes since it's common to disable the WooCommerce gallery and replace with your own. To enable the gallery, you can declare support like this

@ -1,3 +1,20 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
## Table of Contents
- [Description](#description)
- [Usage](#usage)
- [WC_Order_Query Methods](#wc_order_query-methods)
- [Parameters](#parameters)
- [General](#general)
- [Price](#price)
- [Customer](#customer)
- [Address and Name](#address-and-name)
- [Date](#date)
- [Adding Custom Parameter Support](#adding-custom-parameter-support)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
## Description
`wc_get_orders` and `WC_Order_Query` provide a standard way of retrieving orders that is safe to use and will not break due to database changes in future WooCommerce versions. Building custom WP_Queries or database queries is likely to break your code in future versions of WooCommerce as data moves towards custom tables for better performance. This is the best-practices way for plugin and theme developers to retrieve multiple orders. `wc_get_orders` and `WC_Order_Query` are similar to WordPress [`get_posts` and `WP_Query`](https://codex.wordpress.org/Class_Reference/WP_Query). Just like those, you pass in an array of arguments defining the criteria for the search.