add graymatter to docs

This commit is contained in:
Ron Rennick 2023-11-29 14:48:05 -04:00
parent 9a947c1a06
commit 52dcaf91d7
93 changed files with 323 additions and 101 deletions

View File

@ -1,4 +1,6 @@
# WooCommerce developer documentation ---
post_title: WooCommerce developer documentation
---
> ⚠️ **Notice:** This documentation is currently a **work in progress**. While it's open to the public for transparency and collaboration, please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions! > ⚠️ **Notice:** This documentation is currently a **work in progress**. While it's open to the public for transparency and collaboration, please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions!

View File

@ -1,4 +1,6 @@
# WooCommerce code snippets ---
post_title: WooCommerce code snippets
---
Various code snippets you can add to your site to enable custom functionality: Various code snippets you can add to your site to enable custom functionality:

View File

@ -1,4 +1,6 @@
# Add a country ---
post_title: Add a country
---
Add this code to your child themes `functions.php` file or via a plugin that allows custom functions to be added, such as the [Code Snippets](https://wordpress.org/plugins/code-snippets/) plugin. Avoid adding custom code directly to your parent themes functions.php file, as this will be wiped entirely when you update the theme. Add this code to your child themes `functions.php` file or via a plugin that allows custom functions to be added, such as the [Code Snippets](https://wordpress.org/plugins/code-snippets/) plugin. Avoid adding custom code directly to your parent themes functions.php file, as this will be wiped entirely when you update the theme.

View File

@ -1,4 +1,6 @@
# Add a currency and symbol ---
post_title: Add a currency and symbol
---
Add this code to your child themes `functions.php` file or via a plugin that allows custom functions to be added, such as the [Code Snippets](https://wordpress.org/plugins/code-snippets/) plugin. Avoid adding custom code directly to your parent themes functions.php file, as this will be wiped entirely when you update the theme. Add this code to your child themes `functions.php` file or via a plugin that allows custom functions to be added, such as the [Code Snippets](https://wordpress.org/plugins/code-snippets/) plugin. Avoid adding custom code directly to your parent themes functions.php file, as this will be wiped entirely when you update the theme.

View File

@ -1,4 +1,6 @@
# Add or modify states ---
post_title: Add or modify states
---
Add this code to your child themes `functions.php` file or via a plugin that allows custom functions to be added, such as the [Code Snippets](https://wordpress.org/plugins/code-snippets/) plugin. Avoid adding custom code directly to your parent themes functions.php file, as this will be wiped entirely when you update the theme. Add this code to your child themes `functions.php` file or via a plugin that allows custom functions to be added, such as the [Code Snippets](https://wordpress.org/plugins/code-snippets/) plugin. Avoid adding custom code directly to your parent themes functions.php file, as this will be wiped entirely when you update the theme.

View File

@ -1,4 +1,6 @@
# Adjust the quantity input values ---
post_title: Adjust the quantity input values
---
Set the starting value, maximum value, minimum value, and increment amount for quantity input fields on product pages. Set the starting value, maximum value, minimum value, and increment amount for quantity input fields on product pages.

View File

@ -1,4 +1,6 @@
# Add a message above the login / register form ---
post_title: Add a message above the login / register form
---
This code will add a custom message above the login/register form on the users my-account page. This code will add a custom message above the login/register form on the users my-account page.

View File

@ -1,4 +1,6 @@
# Change a currency symbol ---
post_title: Change a currency symbol
---
See the [currency list](https://woocommerce.github.io/code-reference/files/woocommerce-includes-wc-core-functions.html#source-view.475) for reference on currency codes. See the [currency list](https://woocommerce.github.io/code-reference/files/woocommerce-includes-wc-core-functions.html#source-view.475) for reference on currency codes.

View File

@ -1,4 +1,6 @@
# Customizing checkout fields using actions and filters ---
post_title: Customizing checkout fields using actions and filters
---
If you are unfamiliar with code and resolving potential conflicts, we have an extension that can help: [WooCommerce Checkout Field Editor](https://woo.com/products/woocommerce-checkout-field-editor/). Installing and activating this extension overrides any code below that you try to implement; and you cannot have custom checkout field code in your functions.php file when the extension is activated. If you are unfamiliar with code and resolving potential conflicts, we have an extension that can help: [WooCommerce Checkout Field Editor](https://woo.com/products/woocommerce-checkout-field-editor/). Installing and activating this extension overrides any code below that you try to implement; and you cannot have custom checkout field code in your functions.php file when the extension is activated.

View File

@ -1,4 +1,6 @@
# Change number of related products output ---
post_title: Change number of related products output
---
Add code to your child themes functions.php file or via a plugin that allows custom functions to be added, such as the [Code snippets](https://wordpress.org/plugins/code-snippets/) plugin. Avoid adding custom code directly to your parent themes `functions.php` file as this will be wiped entirely when you update the theme. Add code to your child themes functions.php file or via a plugin that allows custom functions to be added, such as the [Code snippets](https://wordpress.org/plugins/code-snippets/) plugin. Avoid adding custom code directly to your parent themes `functions.php` file as this will be wiped entirely when you update the theme.

View File

@ -1,4 +1,6 @@
# Rename a country ---
post_title: Rename a country
---
Add this code to your child themes `functions.php` file or via a plugin that allows custom functions to be added, such as the [Code Snippets](https://wordpress.org/plugins/code-snippets/) plugin. Avoid adding custom code directly to your parent themes functions.php file, as this will be wiped entirely when you update the theme. Add this code to your child themes `functions.php` file or via a plugin that allows custom functions to be added, such as the [Code Snippets](https://wordpress.org/plugins/code-snippets/) plugin. Avoid adding custom code directly to your parent themes functions.php file, as this will be wiped entirely when you update the theme.

View File

@ -1,4 +1,6 @@
# Unhook and remove WooCommerce emails ---
post_title: Unhook and remove WooCommerce emails
---
This code allows you to unhook and remove the default WooCommerce emails. This code allows you to unhook and remove the default WooCommerce emails.

View File

@ -1,4 +1,6 @@
# Useful core functions ---
post_title: Useful core functions
---
WooCommerce core functions are available on both front-end and admin. They can be found in `includes/wc-core-functions.php` and can be used by themes in plugins. WooCommerce core functions are available on both front-end and admin. They can be found in `includes/wc-core-functions.php` and can be used by themes in plugins.

View File

@ -1,4 +1,6 @@
# CSS SASS coding guidelines and naming conventions ---
post_title: CSS SASS coding guidelines and naming conventions
---
Our guidelines are based on those used in [Calypso](https://github.com/Automattic/wp-calypso) which itself follows the BEM methodology. Refer to [this doc](https://wpcalypso.wordpress.com/devdocs/docs/coding-guidelines/css.md?term=css) for full details. There are a few differences in WooCommerce however which are outlined below; Our guidelines are based on those used in [Calypso](https://github.com/Automattic/wp-calypso) which itself follows the BEM methodology. Refer to [this doc](https://wpcalypso.wordpress.com/devdocs/docs/coding-guidelines/css.md?term=css) for full details. There are a few differences in WooCommerce however which are outlined below;

View File

@ -1,4 +1,6 @@
# API critical flows ---
post_title: API critical flows
---
In our documentation, we've pinpointed the essential user flows within the WooCommerce Core API. These flows serve as In our documentation, we've pinpointed the essential user flows within the WooCommerce Core API. These flows serve as
the compass for our testing initiatives, aiding us in concentrating our efforts where they matter most. They also the compass for our testing initiatives, aiding us in concentrating our efforts where they matter most. They also

View File

@ -1,4 +1,6 @@
# Common issues ---
post_title: Common issues
---
This page aims to document a comprehensive list of known issues, commonly encountered problems, and their solutions or workarounds. If you have encountered an issue that is not mentioned here and should be, please don't hesitate to add to the list. This page aims to document a comprehensive list of known issues, commonly encountered problems, and their solutions or workarounds. If you have encountered an issue that is not mentioned here and should be, please don't hesitate to add to the list.

View File

@ -1,4 +1,6 @@
# How to decide if a pull request is high impact ---
post_title: How to decide if a pull request is high impact
---
Deciding if a Pull Request should be declared High-Impact is a complex task. To achieve it, we need to assess and estimate the impact that the changes introduced in the Pull Request have in WooCommerce, which is usually a subjective task and sometimes inaccurate, due to the huge knowledge it demands of the WooCommerce product details, technical details and even customers issues history. Deciding if a Pull Request should be declared High-Impact is a complex task. To achieve it, we need to assess and estimate the impact that the changes introduced in the Pull Request have in WooCommerce, which is usually a subjective task and sometimes inaccurate, due to the huge knowledge it demands of the WooCommerce product details, technical details and even customers issues history.

View File

@ -1,4 +1,6 @@
# Deprecation in core ---
post_title: Deprecation in core
---
Deprecation is a method of discouraging usage of a feature or practice in favour of something else without breaking backwards compatibility or totally prohibiting its usage. To quote the Wikipedia article on Deprecation: Deprecation is a method of discouraging usage of a feature or practice in favour of something else without breaking backwards compatibility or totally prohibiting its usage. To quote the Wikipedia article on Deprecation:

View File

@ -1,5 +1,7 @@
# Minification of SCSS and JS ---
post_title: Minification of SCSS and JS
---
## SCSS ## SCSS

View File

@ -1,4 +1,6 @@
# Naming conventions ---
post_title: Naming conventions
---
## PHP ## PHP

View File

@ -1,4 +1,6 @@
# String localization guidelines ---
post_title: String localization guidelines
---
1. Use `woocommerce` textdomain in all strings. 1. Use `woocommerce` textdomain in all strings.
2. When using dynamic strings in printf/sprintf, if you are replacing > 1 string use numbered args. e.g. `Test %s string %s.` would be `Test %1$s string %2$s.` 2. When using dynamic strings in printf/sprintf, if you are replacing > 1 string use numbered args. e.g. `Test %s string %s.` would be `Test %1$s string %2$s.`

View File

@ -1,4 +1,6 @@
# WooCommerce Git flow ---
post_title: WooCommerce Git flow
---
For core development, we use the following structure and flow. For core development, we use the following structure and flow.

View File

@ -1,4 +1,6 @@
# Developing using WooCommerce CRUD objects ---
post_title: Developing using WooCommerce CRUD objects
---
CRUD is an abbreviation of the four basic operations you can do to a database or resource Create, Read, Update, Delete. CRUD is an abbreviation of the four basic operations you can do to a database or resource Create, Read, Update, Delete.

View File

@ -1,4 +1,6 @@
# Data stores ---
post_title: Data stores
---
## Introduction ## Introduction

View File

@ -1,5 +1,7 @@
# Adding a section to a settings tab ---
post_title: Adding a section to a settings tab
---
When youre adding building an extension for WooCommerce that requires settings of some kind, its important to ask yourself: **Where do they belong?** If your extension just has a couple of simple settings, do you really need to create a new tab specifically for it? Most likely the answer is no. When youre adding building an extension for WooCommerce that requires settings of some kind, its important to ask yourself: **Where do they belong?** If your extension just has a couple of simple settings, do you really need to create a new tab specifically for it? Most likely the answer is no.

View File

@ -1,4 +1,6 @@
# Building your first extension ---
post_title: Building your first extension
---
The easiest way to get started building an extension is to use the built-in extension generator that is included alongside WooCommerce Admin. This utility is maintained as part of the codebase for WooCommerce Admin, so it includes up-to-date tools and many preconfigured settings for building modern extensions that take advantage of the [React-powered](https://react.dev/) user experience available in current versions of WordPress and WooCommerce. The easiest way to get started building an extension is to use the built-in extension generator that is included alongside WooCommerce Admin. This utility is maintained as part of the codebase for WooCommerce Admin, so it includes up-to-date tools and many preconfigured settings for building modern extensions that take advantage of the [React-powered](https://react.dev/) user experience available in current versions of WordPress and WooCommerce.

View File

@ -1,5 +1,7 @@
# Classes in WooCommerce ---
post_title: Classes in WooCommerce
---
## [List of Classes in WooCommerce](https://github.com/woocommerce/woocommerce/blob/trunk/docs/extension-development/class-reference#section-1) ## [List of Classes in WooCommerce](https://github.com/woocommerce/woocommerce/blob/trunk/docs/extension-development/class-reference#section-1)

View File

@ -1,4 +1,6 @@
# Setting up your development environment ---
post_title: Setting up your development environment
---
## Introduction ## Introduction

View File

@ -1,4 +1,6 @@
# WooCommerce extension developer handbook ---
post_title: WooCommerce extension developer handbook
---
Want to create a plugin to extend WooCommerce? WooCommerce extensions are the same as regular WordPress plugins. For more information, visit [Writing a plugin](https://developer.wordpress.org/plugins/). Want to create a plugin to extend WooCommerce? WooCommerce extensions are the same as regular WordPress plugins. For more information, visit [Writing a plugin](https://developer.wordpress.org/plugins/).

View File

@ -1,4 +1,6 @@
# GDPR Compliance Guidelines for WooCommerce Extensions ---
post_title: GDPR Compliance Guidelines for WooCommerce Extensions
---
## Introduction ## Introduction

View File

@ -1,4 +1,6 @@
# Handling deactivation and uninstallation ---
post_title: Handling deactivation and uninstallation
---
## Introduction ## Introduction

View File

@ -1,4 +1,6 @@
# Handling merchant onboarding ---
post_title: Handling merchant onboarding
---
## Introduction ## Introduction

View File

@ -1,4 +1,6 @@
# Adding store management links ---
post_title: Adding store management links
---
## Introduction ## Introduction

View File

@ -1,4 +1,6 @@
# How to design a simple extension ---
post_title: How to design a simple extension
---
## Introduction ## Introduction

View File

@ -1,4 +1,6 @@
# Implementing settings for extensions ---
post_title: Implementing settings for extensions
---
If youre customizing WooCommerce or adding your own functionality to it youll probably need a settings page of some sort. One of the easiest ways to create a settings page is by taking advantage of the [`WC_Integration` class](https://woocommerce.github.io/code-reference/classes/WC-Integration.html 'WC_Integration Class'). Using the Integration class will automatically create a new settings page under **WooCommerce > Settings > Integrations** and it will automatically save, and sanitize your data for you. Weve created this tutorial so you can see how to create a new integration. If youre customizing WooCommerce or adding your own functionality to it youll probably need a settings page of some sort. One of the easiest ways to create a settings page is by taking advantage of the [`WC_Integration` class](https://woocommerce.github.io/code-reference/classes/WC-Integration.html 'WC_Integration Class'). Using the Integration class will automatically create a new settings page under **WooCommerce > Settings > Integrations** and it will automatically save, and sanitize your data for you. Weve created this tutorial so you can see how to create a new integration.

View File

@ -1,4 +1,8 @@
# Extension development ---
category_title: Extension Development
category_slug: extension-development
post_title: Extension development
---
> ⚠️ **Notice:** This documentation is currently a **work in progress**. While it's open to the public for transparency and collaboration, please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions! > ⚠️ **Notice:** This documentation is currently a **work in progress**. While it's open to the public for transparency and collaboration, please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions!

View File

@ -1,4 +1,6 @@
# Settings API ---
post_title: Settings API
---
The WooCommerce Settings API is used by extensions to display, save, and load settings. The best way to make use of the API in your extension is to create a class that extends the `WC_Settings_API` class: The WooCommerce Settings API is used by extensions to display, save, and load settings. The best way to make use of the API in your extension is to create a class that extends the `WC_Settings_API` class:

View File

@ -1,4 +1,6 @@
# Building blocks for low code builders ---
post_title: Building blocks for low code builders
---
## Introduction ## Introduction

View File

@ -1,11 +1,15 @@
# Using custom attributes in menus and taxonomy archives ---
post_title: Using custom attributes in menus and taxonomy archives
---
Attributes that can be used for the layered nav are a custom taxonomy, which means you can display them in menus, or display products by attributes. This requires some work on your part, and archives must be enabled. Attributes that can be used for the layered nav are a custom taxonomy, which means you can display them in menus, or display products by attributes. This requires some work on your part, and archives must be enabled.
> **Note:** This is a **Developer level** doc. If you are unfamiliar with code/templates and resolving potential conflicts, select a [WooExpert or Developer](https://woo.com/customizations/) for assistance. We are unable to provide support for customizations under our [Support Policy](https://woo.com/support-policy/). > **Note:** This is a **Developer level** doc. If you are unfamiliar with code/templates and resolving potential conflicts, select a [WooExpert or Developer](https://woo.com/customizations/) for assistance. We are unable to provide support for customizations under our [Support Policy](https://woo.com/support-policy/).
# Register the taxonomy for menus ---
post_title: Register the taxonomy for menus
---
When registering taxonomies for your custom attributes, WooCommerce calls the following hook: When registering taxonomies for your custom attributes, WooCommerce calls the following hook:
@ -28,7 +32,9 @@ Custom attribute slugs are prefixed with `pa_`, so an attribute called `size` wo
Now use your attribute in **Appearance > Menus**. You will notice, however, that it has default blog styling when you click on a link to your taxonomy term. Now use your attribute in **Appearance > Menus**. You will notice, however, that it has default blog styling when you click on a link to your taxonomy term.
# Create a template ---
post_title: Create a template
---
You need to theme your attribute to make it display products as you want. To do this: You need to theme your attribute to make it display products as you want. To do this:

View File

@ -1,4 +1,6 @@
# WooCommerce Plugin API Callback Documentation ---
post_title: WooCommerce Plugin API Callback Documentation
---
## Overview ## Overview

View File

@ -1,4 +1,6 @@
# Resources for debugging ---
post_title: Resources for debugging
---
## WordPress ## WordPress

View File

@ -1,4 +1,6 @@
# WooCommerce developer resources ---
post_title: WooCommerce developer resources
---
This guide is a great starting point for WooCommerce development. From setting up your first online store to diving deep into advanced features, you'll find what you need here. New to WooCommerce? Start with the basics. Experienced and looking for specific documentation or community discussions? We've got that covered too. Navigate through the sections below to find the resources tailored for you. This guide is a great starting point for WooCommerce development. From setting up your first online store to diving deep into advanced features, you'll find what you need here. New to WooCommerce? Start with the basics. Experienced and looking for specific documentation or community discussions? We've got that covered too. Navigate through the sections below to find the resources tailored for you.

View File

@ -1,4 +1,6 @@
# WooCommerce developer tools ---
post_title: WooCommerce developer tools
---
This guide provides an overview of essential tools and libraries for WooCommerce development. It's intended for developers looking to enhance their WooCommerce projects efficiently. This guide provides an overview of essential tools and libraries for WooCommerce development. It's intended for developers looking to enhance their WooCommerce projects efficiently.

View File

@ -1,4 +1,8 @@
# Getting started ---
category_title: Getting Started
category_slug: getting-started
post_title: Getting started
---
> ⚠️ **Notice:** This documentation is currently a **work in progress**. While it's open to the public for transparency and collaboration, please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions! > ⚠️ **Notice:** This documentation is currently a **work in progress**. While it's open to the public for transparency and collaboration, please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions!

View File

@ -1,4 +1,6 @@
# Set up and use a child theme ---
post_title: Set up and use a child theme
---
**Note:** This document is intended for creating and using classic child themes. For a comprehensive guide on creating a child block theme and understanding the differences between a classic and block theme, please refer to [this detailed documentation](https://learn.wordpress.org/lesson-plan/create-a-basic-child-theme-for-block-themes/). **Note:** This document is intended for creating and using classic child themes. For a comprehensive guide on creating a child block theme and understanding the differences between a classic and block theme, please refer to [this detailed documentation](https://learn.wordpress.org/lesson-plan/create-a-basic-child-theme-for-block-themes/).

View File

@ -1,4 +1,6 @@
# WooCommerce Endpoints ---
post_title: WooCommerce Endpoints
---
**Note:** We are unable to provide support for customizations under our **[Support Policy](https://woo.com/support-policy/)**. If you need to further customize a snippet, or extend its functionality, we highly recommend [**Codeable**](https://codeable.io/?ref=z4Hnp), or a [**Certified WooExpert**](https://woo.com/experts/). **Note:** We are unable to provide support for customizations under our **[Support Policy](https://woo.com/support-policy/)**. If you need to further customize a snippet, or extend its functionality, we highly recommend [**Codeable**](https://codeable.io/?ref=z4Hnp), or a [**Certified WooExpert**](https://woo.com/experts/).

View File

@ -1,4 +1,6 @@
# High Performance Order Storage (HPOS) ---
post_title: High Performance Order Storage (HPOS)
---
WooCommerce has traditionally stored store orders and related order information (like refunds) as custom WordPress post types or post meta records. This comes with performance issues. WooCommerce has traditionally stored store orders and related order information (like refunds) as custom WordPress post types or post meta records. This comes with performance issues.

View File

@ -1,4 +1,6 @@
# How to enable HPOS ---
post_title: How to enable HPOS
---
From WooCommerce 8.2, released on October 2023, HPOS is enabled by default for new installations. Existing stores can switch to the “High-Performance Order Storage” from “WordPress Posts Storage” by following the below steps. From WooCommerce 8.2, released on October 2023, HPOS is enabled by default for new installations. Existing stores can switch to the “High-Performance Order Storage” from “WordPress Posts Storage” by following the below steps.

View File

@ -1,4 +1,6 @@
# Translating WooCommerce ---
post_title: Translating WooCommerce
---
WooCommerce is already translated into several languages and is translation-ready right out of the box. All thats needed is a translation file for your language. WooCommerce is already translated into several languages and is translation-ready right out of the box. All thats needed is a translation file for your language.

View File

@ -1,4 +1,6 @@
# Payment gateway API ---
post_title: Payment gateway API
---
Payment gateways in WooCommerce are class based and can be added through traditional plugins. This guide provides an intro to gateway development. Payment gateways in WooCommerce are class based and can be added through traditional plugins. This guide provides an intro to gateway development.

View File

@ -1,4 +1,6 @@
# WooCommerce payment gateway plugin base ---
post_title: WooCommerce payment gateway plugin base
---
This code can be used as a base to create your own simple custom payment gateway for WooCommerce. If not used in a custom plugin, you need to add this code to your child themes functions.php file or via a plugin that allows custom functions to be added, such as the [Code snippets](https://wordpress.org/plugins/code-snippets/) plugin. Please dont add custom code directly to your parent themes functions.php file as this will be wiped entirely when you update the theme. This code can be used as a base to create your own simple custom payment gateway for WooCommerce. If not used in a custom plugin, you need to add this code to your child themes functions.php file or via a plugin that allows custom functions to be added, such as the [Code snippets](https://wordpress.org/plugins/code-snippets/) plugin. Please dont add custom code directly to your parent themes functions.php file as this will be wiped entirely when you update the theme.

View File

@ -1,4 +1,6 @@
# Payment token API ---
post_title: Payment token API
---
WooCommerce 2.6 introduced an API for storing and managing payment tokens for gateways. Users can also manage these tokens from their account settings and choose from saved payment tokens on checkout. WooCommerce 2.6 introduced an API for storing and managing payment tokens for gateways. Users can also manage these tokens from their account settings and choose from saved payment tokens on checkout.

View File

@ -1,4 +1,6 @@
# Product Editor Development Handbook ---
post_title: Product Editor Development Handbook
---
> ⚠️ **Notice:** This documentation is currently a **work in progress**. Please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions! > ⚠️ **Notice:** This documentation is currently a **work in progress**. Please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions!

View File

@ -1,4 +1,6 @@
# Block template lifecycle ---
post_title: Block template lifecycle
---
A block template is a tree structure of blocks that define the product editor's form structure. A block template is a tree structure of blocks that define the product editor's form structure.

View File

@ -1,4 +1,6 @@
# Product editor extensibility guidelines ---
post_title: Product editor extensibility guidelines
---
> ⚠️ **Notice:** These guidelines are currently a **work in progress**. Please be aware that some details might be incomplete or subject to change. We appreciate your patience and welcome any contributions! > ⚠️ **Notice:** These guidelines are currently a **work in progress**. Please be aware that some details might be incomplete or subject to change. We appreciate your patience and welcome any contributions!

View File

@ -1,4 +1,6 @@
# Coding standards for the code snippets within the WooCommerce documentation ---
post_title: Coding standards for the code snippets within the WooCommerce documentation
---
## Position of hooks ## Position of hooks

View File

@ -1,4 +1,6 @@
# WooCommerce core critical flows ---
post_title: WooCommerce core critical flows
---
We have identified what we consider to be our most critical user flows within WooCommerce Core. These flows will help us focus and prioritize our testing efforts. They will also help us consider the impact of changes and priority of issues. We have identified what we consider to be our most critical user flows within WooCommerce Core. These flows will help us focus and prioritize our testing efforts. They will also help us consider the impact of changes and priority of issues.

View File

@ -1,4 +1,6 @@
# CSS/Sass naming conventions ---
post_title: CSS/Sass naming conventions
---
Table of Contents: Table of Contents:

View File

@ -1,4 +1,6 @@
# WooCommerce grammar, punctuation and capitalization guide ---
post_title: WooCommerce grammar, punctuation and capitalization guide
---
Following grammar, punctuation and style guidelines helps keep our presentation consistent. Users have a better experience if they know what to expect and where to find the information they need. Following grammar, punctuation and style guidelines helps keep our presentation consistent. Users have a better experience if they know what to expect and where to find the information they need.

View File

@ -1,4 +1,6 @@
# Naming conventions ---
post_title: Naming conventions
---
Table of Contents: Table of Contents:

View File

@ -1,4 +1,6 @@
# Performance optimization for WooCommerce stores ---
post_title: Performance optimization for WooCommerce stores
---
## Introduction ## Introduction

View File

@ -1,4 +1,8 @@
# Quality and best practices ---
category_title: Quality Practices Best And
category_slug: quality-and-best-practices
post_title: Quality and best practices
---
> ⚠️ **Notice:** This documentation is currently a **work in progress**. While it's open to the public for transparency and collaboration, please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions! > ⚠️ **Notice:** This documentation is currently a **work in progress**. While it's open to the public for transparency and collaboration, please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions!

View File

@ -1,5 +1,7 @@
# Removing /product/ , /product-category/ , or /shop/ from the URLs ---
post_title: Removing /product/ , /product-category/ , or /shop/ from the URLs
---
**Note:** This is a **Developer level** doc. If you are unfamiliar with code/templates and resolving potential conflicts, select a [WooExpert or Developer](https://woo.com/customizations/) for assistance. We are unable to provide support for customizations under our [Support Policy](https://woo.com/support-policy/). **Note:** This is a **Developer level** doc. If you are unfamiliar with code/templates and resolving potential conflicts, select a [WooExpert or Developer](https://woo.com/customizations/) for assistance. We are unable to provide support for customizations under our [Support Policy](https://woo.com/support-policy/).

View File

@ -1,4 +1,6 @@
# Writing high quality testing instructions ---
post_title: Writing high quality testing instructions
---
## Introduction ## Introduction

View File

@ -1,4 +1,6 @@
# Adding columns to analytics reports and CSV downloads ---
post_title: Adding columns to analytics reports and CSV downloads
---
Adding columns to analytics reports are a really interesting way to add functionality to WooCommerce. New data can be consumed in the table view of the user interface and in your user's favourite spreadsheet or third party application by generating a CSV. Adding columns to analytics reports are a really interesting way to add functionality to WooCommerce. New data can be consumed in the table view of the user interface and in your user's favourite spreadsheet or third party application by generating a CSV.

View File

@ -1,4 +1,6 @@
# Extending WooCommerce Analytics reports ---
post_title: Extending WooCommerce Analytics reports
---
## Introduction ## Introduction

View File

@ -1,4 +1,8 @@
# Reporting ---
category_title: Reporting
category_slug: reporting
post_title: Reporting
---
> ⚠️ **Notice:** This documentation is currently a **work in progress**. While it's open to the public for transparency and collaboration, please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions! > ⚠️ **Notice:** This documentation is currently a **work in progress**. While it's open to the public for transparency and collaboration, please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions!

View File

@ -1,4 +1,6 @@
# Getting started with the REST API ---
post_title: Getting started with the REST API
---
The REST API is a powerful part of WooCommerce which lets you read and write various parts of WooCommerce data such as orders, products, coupons, customers, and shipping zones. The REST API is a powerful part of WooCommerce which lets you read and write various parts of WooCommerce data such as orders, products, coupons, customers, and shipping zones.

View File

@ -1,4 +1,8 @@
# REST API ---
category_title: Rest Api
category_slug: rest-api
post_title: REST API
---
> ⚠️ **Notice:** This documentation is currently a **work in progress**. While it's open to the public for transparency and collaboration, please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions! > ⚠️ **Notice:** This documentation is currently a **work in progress**. While it's open to the public for transparency and collaboration, please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions!

View File

@ -1,4 +1,8 @@
# Security ---
category_title: Security
category_slug: security
post_title: Security
---
> ⚠️ **Notice:** This documentation is currently a **work in progress**. While it's open to the public for transparency and collaboration, please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions! > ⚠️ **Notice:** This documentation is currently a **work in progress**. While it's open to the public for transparency and collaboration, please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions!

View File

@ -1,4 +1,6 @@
# Reporting security issues ---
post_title: Reporting security issues
---
WooCommerce cares deeply about security and works hard to keep our merchants and their customers safe. WooCommerce cares deeply about security and works hard to keep our merchants and their customers safe.

View File

@ -1,4 +1,6 @@
# WooCommerce security best practices ---
post_title: WooCommerce security best practices
---
## Introduction ## Introduction

View File

@ -1,4 +1,6 @@
# Shipping method API ---
post_title: Shipping method API
---
WooCommerce has a shipping method API which plugins can use to add their own rates. This article will take you through the steps to creating a new shipping method and interacting with the API. WooCommerce has a shipping method API which plugins can use to add their own rates. This article will take you through the steps to creating a new shipping method and interacting with the API.

View File

@ -1,4 +1,6 @@
# Technical documentation style guide ---
post_title: Technical documentation style guide
---
This style guide is intended to provide guidelines for creating effective and user-friendly tutorials and how-to guides for WooCommerce technical documentation that will live in repo and be editable and iterative by open source contributors and WooCommerce teams. This style guide is intended to provide guidelines for creating effective and user-friendly tutorials and how-to guides for WooCommerce technical documentation that will live in repo and be editable and iterative by open source contributors and WooCommerce teams.
@ -62,7 +64,9 @@ Note: While we've outlined specific rules above, all other default linting rules
- Use the ATX-style (`#`) for headers. - Use the ATX-style (`#`) for headers.
```markdown ```markdown
---
# This is an H1 # This is an H1
---
## This is an H2 ## This is an H2
``` ```

View File

@ -1,4 +1,6 @@
# Theme Design and Development at Woo ---
post_title: Theme Design and Development at Woo
---
## Classic Themes ## Classic Themes

View File

@ -1,4 +1,6 @@
# Classic Theme Developer Handbook ---
post_title: Classic Theme Developer Handbook
---
--- ---

View File

@ -1,4 +1,6 @@
# Conditional tags ---
post_title: Conditional tags
---
**Note:** This is a **Developer level** doc. If you are unfamiliar with code/tags and resolving potential conflicts, select a [WooExpert or Developer](https://woo.com/customizations/) for assistance. We are unable to provide support for customizations under our [Support Policy](https://woo.com/support-policy/). **Note:** This is a **Developer level** doc. If you are unfamiliar with code/tags and resolving potential conflicts, select a [WooExpert or Developer](https://woo.com/customizations/) for assistance. We are unable to provide support for customizations under our [Support Policy](https://woo.com/support-policy/).

View File

@ -1,4 +1,6 @@
# Fixing outdated WooCommerce templates ---
post_title: Fixing outdated WooCommerce templates
---
## Template Updates and Changes ## Template Updates and Changes

View File

@ -1,4 +1,6 @@
# Theme design and user experience guidelines ---
post_title: Theme design and user experience guidelines
---
This guide covers general guidelines and best practices to follow in order to ensure your theme experience aligns with ecommerce industry standards and WooCommerce for providing a great online shopping experience, maximizing sales, ensuring ease of use, seamless integration, and strong UX adoption. This guide covers general guidelines and best practices to follow in order to ensure your theme experience aligns with ecommerce industry standards and WooCommerce for providing a great online shopping experience, maximizing sales, ensuring ease of use, seamless integration, and strong UX adoption.

View File

@ -1,4 +1,6 @@
# Adding a custom field to simple and variable products ---
post_title: Adding a custom field to simple and variable products
---
In this tutorial you will learn how to create a custom field for a product and show it in your store. Together we will set up the skeleton plugin, and learn about WP naming conventions and WooCommerce hooks. In the end, you will have a functioning plugin for adding a custom field. In this tutorial you will learn how to create a custom field for a product and show it in your store. Together we will set up the skeleton plugin, and learn about WP naming conventions and WooCommerce hooks. In the end, you will have a functioning plugin for adding a custom field.

View File

@ -1,4 +1,6 @@
# Adding actions and filters ---
post_title: Adding actions and filters
---
Like many WordPress plugins, WooCommerce provides a range of actions and filters through which developers can extend and modify the platform. Like many WordPress plugins, WooCommerce provides a range of actions and filters through which developers can extend and modify the platform.

View File

@ -1,4 +1,8 @@
# Tutorials ---
category_title: Tutorials
category_slug: tutorials
post_title: Tutorials
---
> ⚠️ **Notice:** This documentation is currently a **work in progress**. While it's open to the public for transparency and collaboration, please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions! > ⚠️ **Notice:** This documentation is currently a **work in progress**. While it's open to the public for transparency and collaboration, please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions!

View File

@ -1,4 +1,6 @@
# User experience guidelines: accessibility ---
post_title: User experience guidelines: accessibility
---
## Accessibility ## Accessibility

View File

@ -1,4 +1,6 @@
# User experience guidelines: best practices ---
post_title: User experience guidelines: best practices
---
## Best practices ## Best practices

View File

@ -1,4 +1,6 @@
# User experience guidelines: colors ---
post_title: User experience guidelines: colors
---
## Colors ## Colors

View File

@ -1,4 +1,6 @@
# User experience guidelines: notices ---
post_title: User experience guidelines: notices
---
## Notices ## Notices

View File

@ -1,4 +1,6 @@
# User experience guidelines: onboarding ---
post_title: User experience guidelines: onboarding
---
## Onboarding ## Onboarding

View File

@ -1,4 +1,6 @@
# User experience guidelines: task list and inbox ---
post_title: User experience guidelines: task list and inbox
---
## Task List & Inbox ## Task List & Inbox

View File

@ -1,4 +1,6 @@
# User experience guidelines ---
post_title: User experience guidelines
---
This guide covers general guidelines, and best practices to follow in order to ensure your product experience aligns with WooCommerce for ease of use, seamless integration, and strong adoption. This guide covers general guidelines, and best practices to follow in order to ensure your product experience aligns with WooCommerce for ease of use, seamless integration, and strong adoption.

View File

@ -1,4 +1,6 @@
# Configuring Caching Plugins for WooCommerce ---
post_title: Configuring Caching Plugins for WooCommerce
---
## Excluding Pages from the Cache ## Excluding Pages from the Cache
@ -62,35 +64,51 @@ Check out the following WordPress.org Support forum post on[ how cookies may be
```text ```text
Add this to vcl_recv above "if (req.http.cookie) {": Add this to vcl_recv above "if (req.http.cookie) {":
# Unset Cookies except for WordPress admin and WooCommerce pages ---
post_title: Unset Cookies except for WordPress admin and WooCommerce pages
---
if (!(req.url ~ "(wp-login|wp-admin|cart|my-account/*|wc-api*|checkout|addons|logout|lost-password|product/*)")) { if (!(req.url ~ "(wp-login|wp-admin|cart|my-account/*|wc-api*|checkout|addons|logout|lost-password|product/*)")) {
unset req.http.cookie; unset req.http.cookie;
} }
# Pass through the WooCommerce dynamic pages ---
post_title: Pass through the WooCommerce dynamic pages
---
if (req.url ~ "^/(cart|my-account/*|checkout|wc-api/*|addons|logout|lost-password|product/*)") { if (req.url ~ "^/(cart|my-account/*|checkout|wc-api/*|addons|logout|lost-password|product/*)") {
return (pass); return (pass);
} }
# Pass through the WooCommerce add to cart ---
post_title: Pass through the WooCommerce add to cart
---
if (req.url ~ "\?add-to-cart=" ) { if (req.url ~ "\?add-to-cart=" ) {
return (pass); return (pass);
} }
# Pass through the WooCommerce API ---
post_title: Pass through the WooCommerce API
---
if (req.url ~ "\?wc-api=" ) { if (req.url ~ "\?wc-api=" ) {
return (pass); return (pass);
} }
# Block access to php admin pages via website ---
post_title: Block access to php admin pages via website
---
if (req.url ~ "^/phpmyadmin/.*$" || req.url ~ "^/phppgadmin/.*$" || req.url ~ "^/server-status.*$") { if (req.url ~ "^/phpmyadmin/.*$" || req.url ~ "^/phppgadmin/.*$" || req.url ~ "^/server-status.*$") {
error 403 "For security reasons, this URL is only accesible using localhost (127.0.0.1) as the hostname"; error 403 "For security reasons, this URL is only accesible using localhost (127.0.0.1) as the hostname";
} }
---
# #
---
Add this to vcl_fetch: Add this to vcl_fetch:
# Unset Cookies except for WordPress admin and WooCommerce pages ---
post_title: Unset Cookies except for WordPress admin and WooCommerce pages
---
if ( (!(req.url ~ "(wp-(login|admin)|login|cart|my-account/*|wc-api*|checkout|addons|logout|lost-password|product/*)")) || (req.request == "GET") ) { if ( (!(req.url ~ "(wp-(login|admin)|login|cart|my-account/*|wc-api*|checkout|addons|logout|lost-password|product/*)")) || (req.request == "GET") ) {
unset beresp.http.set-cookie; unset beresp.http.set-cookie;
} }
---
# #
---
``` ```
### Why is my Password Reset stuck in a loop? ### Why is my Password Reset stuck in a loop?

View File

@ -1,4 +1,6 @@
# Logging in WooCommerce ---
post_title: Logging in WooCommerce
---
WooCommerce has its own robust system for logging, which can be used for debugging during development, catching errors on production, or even sending notifications when specific events occur. By default, WooCommerce uses this logger to record errors, warnings, and other notices that may be useful for troubleshooting problems with a store. Many extensions for WooCommerce also make use of the logger for similar purposes. WooCommerce has its own robust system for logging, which can be used for debugging during development, catching errors on production, or even sending notifications when specific events occur. By default, WooCommerce uses this logger to record errors, warnings, and other notices that may be useful for troubleshooting problems with a store. Many extensions for WooCommerce also make use of the logger for similar purposes.

View File

@ -1,4 +1,6 @@
# WC CLI: commands ---
post_title: WC CLI: commands
---
## wc shop_coupon ## wc shop_coupon

View File

@ -1,4 +1,6 @@
# WC CLI: overview ---
post_title: WC CLI: overview
---
WooCommerce CLI (WC-CLI) offers the ability to manage WooCommerce (WC) via the command-line, using WP CLI. The documentation here covers the version of WC CLI that started shipping in WC 3.0.0 and later. WooCommerce CLI (WC-CLI) offers the ability to manage WooCommerce (WC) via the command-line, using WP CLI. The documentation here covers the version of WC CLI that started shipping in WC 3.0.0 and later.