Included Widgets

• Active Product Filters – Display a list of active filters.
• Cart
• Filter Products by Attribute – Display a list of attributes to filter products in your store.
• Filter Products by Price – Display a slider to filter products in your store by price.
• Filter Products by Rating – Display a list of star ratings to filter products in your store.
• Product Categories – A list or dropdown of product categories.
• Products – A list of your store’s products.
• Products by Rating – A list of your store’s top-rated products.
• Product Search – A search form for your store.
• Product Tag Cloud – A cloud of your most used product tags.
• Recent Product Reviews – Display a list of recent reviews from your store.
• Recent Viewed Products – Display a list of a customer’s recently viewed products.

Location

Depending on your theme and the widget selected, you may see options on where it can be placed. In the example, we’re using the Storefront theme and the Products widget; your options may differ.

Select a location, and then Add Widget.

Highlighted Widgets

Products

With the Products widget, you can display your products ordered by date, price, sales or randomly. Additionally, you can display products from all of your products, only featured products or only products on sale.

You can set a title for the widget, number of products to show, and reorder them.

Examples:

• To show most recent products, use All Products, Order by Date, and Order DESC.
• To show 10 random featured products, set Number of products to show for 10, then use Featured Products, and then order by Random. 
  

Filter Products by Price

The Filter Products by Price widget allows customers to refine products by price by dragging the sliders within the widget to create a price range based on the products displayed on the page.

To use the widget, drag it to a widget area as you would any other widget. It automatically detects the minimum and maximum prices on the current page to populate the slider.

Filter Products by Attribute

Filter Products by Attribute is a powerful widget that let’s users drill-down through your catalog of products via attributes, effectively helping them find what they’re looking for quickly.

Add the widget to your widgetized area.

Then choose an attribute to filter by and whether you want users to filter by “AND” or “OR” query types.

• AND – If a user selects two attributes, only products which match both attributes will be returned
• OR – If a user selects two attributes, products which match either attribute will be returned

The post Widgets included with WooCommerce first appeared on CODIBU.

How to use shortcodes

Where to use

Shortcodes can be used on pages and posts in WordPress. If you are using the block editor, there is a shortcode block you can use to paste the shortcode in.

If you are using the classic editor, you can paste the shortcode on the page or post.

Args (or Arguments)

Several of the shortcodes below will mention “Args”. These are ways to make the shortcode more specific. For example, by adding id="99" to the add_to_cart shortcode, it will create an add-to-cart button for the product with ID 99.

Page Shortcodes

WooCommerce cannot function properly without the first three shortcodes being somewhere on your site.

woocommerce_cart – shows the cart page
woocommerce_checkout – shows the checkout page
woocommerce_my_account – shows the user account page
woocommerce_order_tracking – shows the order tracking form

In most cases, these shortcodes will be added to pages automatically via our onboarding wizard and do not need to be used manually.

Cart

Used on the cart page, the cart shortcode displays cart content and interface for coupon codes and other cart bits and pieces.

Args: none

woocommerce_cart

Checkout

Used on the checkout page, the checkout shortcode displays the checkout process.

Args: none

woocommerce_checkout

My Account

Shows the ‘my account’ section where the customer can view past orders and update their information. You can specify the number of orders to show. By default, it’s set to 15 (use -1 to display all orders.)

Args:

array(
     'current_user' => ''
 )

woocommerce_my_account

Order Tracking Form

Lets a user see the status of an order by entering their order details.

Args: none

woocommerce_order_tracking

Products

The products shortcode is one of our most robust shortcodes, which can replace various other strings used in earlier versions of WooCommerce.

The products shortcode allows you to display products by post ID, SKU, categories, attributes, with support for pagination, random sorting, and product tags, replacing the need for multiples shortcodes such as  featured_products, sale_products, best_selling_products, recent_products, product_attribute, and top_rated_products, which are needed in versions of WooCommerce below 3.2. Review the examples below.

Available Product Attributes

The following attributes are available to use in conjunction with the products shortcode. They have been split into sections for primary function for ease of navigation, with examples below.

Display Product Attributes

• limit – The number of products to display. Defaults to and -1 (display all)  when listing products, and -1 (display all) for categories.
• columns – The number of columns to display. Defaults to 4.
• paginate – Toggles pagination on. Use in conjunction with limit. Defaults to false set to true to paginate .
• orderby – Sorts the products displayed by the entered option. One or more options can be passed by adding both slugs with a space between them. Available options are:
  • date – The date the product was published.
  • id – The post ID of the product.
  • menu_order – The Menu Order, if set (lower numbers display first).
  • popularity – The number of purchases.
  • rand – Randomly order the products on page load (may not work with sites that use caching, as it could save a specific order).
  • rating – The average product rating.
  • title – The product title. This is the default orderby mode.
• skus – Comma-separated list of product SKUs.
• category – Comma-separated list of category slugs.
• tag – Comma-separated list of tag slugs.
• order – States whether the product order is ascending (ASC) or descending (DESC), using the method set in orderby. Defaults to ASC.
• class – Adds an HTML wrapper class so you can modify the specific output with custom CSS.
• on_sale – Retrieve on sale products. Not to be used in conjunction with best_sellingor top_rated.
• best_selling – Retrieve the best selling products. Not to be used in conjunction with on_sale or top_rated.
• top_rated – Retrieve top-rated products. Not to be used in conjunction with on_saleor best_selling.

Content Product Attributes

• attribute – Retrieves products using the specified attribute slug.
• terms – Comma-separated list of attribute terms to be used with attribute.
• terms_operator – Operator to compare attribute terms. Available options are:
  • AND – Will display products from all of the chosen attributes.
  • IN – Will display products with the chosen attribute. This is the default terms_operator value.
  • NOT IN – Will display products that are not in the chosen attributes.
• tag_operator – Operator to compare tags. Available options are:
  • AND – Will display products from all of the chosen tags.
  • IN – Will display products with the chosen tags. This is the default tag_operator value.
  • NOT IN – Will display products that are not in the chosen tags.
• visibility – Will display products based on the selected visibility. Available options are:
  • visible – Products visible on shop and search results. This is the default visibility option.
  • catalog – Products visible on the shop only, but not search results.
  • search – Products visible in search results only, but not on the shop.
  • hidden – Products that are hidden from both shop and search, accessible only by direct URL.
  • featured – Products that are marked as Featured Products.

• category – Retrieves products using the specified category slug.
• tag – Retrieves products using the specified tag slug.
• cat_operator – Operator to compare category terms. Available options are:
  • AND – Will display products that belong in all of the chosen categories.
  • IN – Will display products within the chosen category. This is the default cat_operator value.
  • NOT IN – Will display products that are not in the chosen category.

• ids – Will display products based on a comma-separated list of Post IDs.
• skus – Will display products based on a comma-separated list of SKUs.

If the product is not showing, make sure it is not set to “Hidden” in the “Catalog Visibility”.

Special Product Attributes

These attributes cannot be used with the “Content Attributes” listed above, as they will likely cause a conflict and not display. You should only use one of the following special attributes.

• best_selling – Will display your best selling products. Must be set to true.
• on_sale – Will display your on-sale products. Must be set to true.

Examples of Product Scenarios

In the following scenarios, we’ll use an example clothing store.

Scenario 1 – Random Sale Items

I want to display four random on sale products.

products limit="4" columns="4" orderby="popularity" class="quick-sale" on_sale="true"

This shortcode explicity states four products with four columns (which will be one row), showing the most popular on-sale items. It also adds a CSS class quick-sale, which I can modify in my theme.

Scenario 2 – Featured Products

I want to display my featured products, two per row, with a maximum of four items.

products limit="4" columns="2" visibility="featured" 

This shortcode says up to four products will load in two columns, and that they must be featured. Although not explicitly stated, it uses the defaults such as sorting by title (A to Z).

Scenario 3 – Best Selling Products

I want to display my three top best selling products in one row.

products limit="3" columns="3" best_selling="true" 

Scenario 4 – Newest Products

I want to display the newest products first – four products across one row. To accomplish this, we’ll use the Post ID (which is generated when the product page is created), along with the order and orderby command. Since you can’t see the Post ID from the frontend, the ID#s have been superimposed over the images.

products limit="4" columns="4" orderby="id" order="DESC" visibility="visible"

Scenario 5 – Specific Categories

I only want to display hoodies and shirts, but not accessories. I’ll use two rows of four.

products limit="8" columns="4" category="hoodies, tshirts" cat_operator="AND"

Alternatively, I only want to display products not in those categories. All I need to change is the cat_operator to NOT IN.

products limit="8" columns="4" category="hoodies, tshirts" cat_operator="NOT IN"

Note that even though the limit is set to 8, there are only four products that fit that criteria, so four products are displayed.

Scenario 6 – Attribute Display

Each of the clothing items has an attribute, either “Spring/Summer” or “Fall/Winter” depending on the appropriate season, with some accessories having both since they can be worn all year. In this example, I want three products per row, displaying all of the “Spring/Summer” items. That attribute slug is season, and the attributes are warm and cold. I also want them sorted from the newest products to the oldest.

products columns="3" attribute="season" terms="warm" orderby="date"

Alternatively, if I wanted to display exclusively cold weather products, I could add NOT IN as my terms_operator:

products columns="3" attribute="season" terms="warm" terms_operator="NOT IN"

Note that by using NOT IN, I exclude products that are both in “Spring/Summer” and “Fall/Winter”. If I wanted to show all cold-weather appropriate gear including these shared accessories, I would change the term from warm to cold.

Scenario 7 – Show Only Products With tag “hoodie”

products tag="hoodie"

Sorting Products by Custom Meta Fields

When using the Products shortcode, you can choose to order products by the pre-defined values above. You can also sort products by custom meta fields using the code below (in this example we order products by price):

add_filter( 'woocommerce_shortcode_products_query', 'woocommerce_shortcode_products_orderby' );

function woocommerce_shortcode_products_orderby

You need to place this snippet in functions.php in your theme folder and then customize it by editing the meta_key.

Product Category

These two shortcodes will display your product categories on any page.

• product_category – Will display products in a specified product category.
• product_categories – Will display all your product categories.

Available Product Category attributes

• ids – Specify specific category ids to be listed. To be used in product_categories
• category – Can be either the category id, name or slug. To be used in product_category
• limit – The number of categories to display
• columns – The number of columns to display. Defaults to 4
• hide_empty – The default is “1” which will hide empty categories. Set to “0” to show empty categories
• parent – Set to a specific category ID if you would like to display all the child categories. Alternatively, set to “0” (like in the example below) to show only the top level categories.
• orderby – The default is to order by “name”, can be set to “id”, “slug”, or “menu_order”. If you want to order by the ids you specified then you can use orderby="include"
• order – States whether the category ordering is ascending (ASC) or descending (DESC), using the method set in orderby. Defaults to ASC.

Examples of Product Category Scenarios

Scenario 8 – Show Top Level Categories Only

Imagine you only wanted to show top level categories on a page and exclude the sub categories, well it’s possible with the following shortcode.

Product Page

Show a full single product page by ID or SKU.

Related Products

List related products.

Args:

array(
     'limit' => '12',
     'columns' => '4',
     'orderby' => 'title'
 )

limit Argument

Add to Cart

Show the price and add to cart button of a single product by ID.

Add to Cart URL

Display the URL on the add to cart button of a single product by ID.

Display WooCommerce notifications on pages that are not WooCommerce

shop_messages allows you to show WooCommerce notifications (like, ‘The product has been added to cart’) on non-WooCommerce pages. Helpful when you use other shortcodes, like add_to_cart, and would like the users to get some feedback on their actions.

Troubleshooting Shortcodes

If you correctly pasted your shortcodes and the display looks incorrect, make sure you did not embed the shortcode between <pre> tags. This is a common issue. To remove these tags, edit the page, and click the Text tab:

Another common problem is that straight quotation marks (") are displayed as curly quotation marks (“). For the shortcodes to work correctly, you need straight quotation marks.

The post Shortcodes included with WooCommerce first appeared on CODIBU.

There are several methods to create a translation, most of which are outlined in the WordPress Codex. In most cases you can contribute to the project on translate.wordpress.org. For creating custom translations:

• The easiest method is to use a plugin called Loco Translate.
• More advanced users can use PoEdit.

Both methods are covered in this doc.

Set up WordPress in your language

WordPress needs to be told which language it should run.

1. Go to: Dashboard > Settings > General and change the Site language.
2. Go to:  Dashboard > Updates and click on the button to update translations

Once this has been done, the shop displays in your locale if the language file exists. Otherwise, you need to create the language files (process explained below).

Contributing your Localization to Core

We maintain translations at our project on GlotPress. If you want to contribute translated strings to your language or wish to start a new translation, register at WordPress.org and start translating.

Translating WooCommerce into your language

Translation is managed by teams over at translate.wordpress.org. Stable versions and development versions of WooCommerce are translated here, and anyone can contribute.

When you install or update WooCommerce, WordPress will look for a 100% complete translation in your language and automatically download it. If there is no 100% complete translation you can download it manually, or we encourage you to contribute to get it to 100% so all users can benefit.

If you’re new to translating, checkout the translators handbook to get started.

Downloading translations from translate.wordpress.org manually

1/ Go to https://translate.wordpress.org/projects/wp-plugins/woocommerce and look for your language in the list.

2/ Click the title to be taken to the section for that language.

3/ Click the heading under Set/Sub Project to view and download a Stable version.

4/ Scroll to the bottom for export options. Export a .mo file for use on your site.

5/ Rename this file to  woocommerce-YOURLANG.mo (e.g., Great Britain English should be en_GB).

6/ Upload to your site under  wp-content/languages/woocommerce/. Once uploaded, this translation file may be used.

Creating custom translations

WooCommerce includes a language file (.pot file) that contains all of the English text. You can find this language file inside the plugin folder in woocommerce/i18n/languages/.

Creating custom translations with Loco Translate

1/ Download the free plugin called Loco Translate from here. Or add directly from the WordPress administration via Plugins > Add New.

2/ Install and Activate.

3/ Go to the new Loco Translate menu item created in your Dashboard with five sub-sections.

4/ Go to the Plugins section, and select WooCommerce:

5/ Add new languages using the Add New Language link:

6/ Choose the language to add in the list, or enter the language ISO code (ex: fr_FR, en_US etc…), and select the folder to add the translation files to, and click Start Translating:

Note that Loco Translate offers three different locations for your create the translating, the best choice is Custom if you are looking to have your own custom translating, you should avoid “Author” location since it’s inside the plugin and will be override on updates, there is also the “System” location that will be override by translations from translate.wordpress.org.

7/ Save when finished:

Note that when a new version of WooCommerce is released and updated on your site, you need refresh the .po file to look for new strings. Use the “Sync” button to find any new string to start translating.

Creating custom translations with PoEdit

PoEdit is a more advanced alternative to Loco Translate. Only advanced users or translators wishing to create a custom translation to WooCommerce should attempt this method.

WooCommerce comes with a POT file that can be imported into PoEdit to translate.

To get started:

1/ Open PoEdit and go to File > New catalog from POT file.

2/ Choose woocommerce.pot and PoEdit will show the catalog properties window:

3/ Enter your name and details, so other translators know who you are, and click ‘OK‘.

4/ Save your .po file. Name it based on what you are translating to, i.e., a GB translation is saved as woocommerce-en_GB.po . Now the strings are listed.

5/ Save after translating strings. The .mo file is generated automatically.

6/ Update your .po file by opening it and then go to Catalog > Update from POT file.

7/ Choose the file and it will be updated accordingly.

Making your translation upgrade safe

WooCommerce keeps translations in wp-content/languages/plugins, like all other plugins. But if you wish to include a custom translation, you can use the directory wp-content/languages/woocommerce, or you can use a snippet to load a custom translation stored elsewhere:

Translating text without a localization file

Translate or replace default text

Using the Say What? plugin can assist if you only wish to translate or change a few words without editing a WordPress theme’s .PO file. Requires no custom code.

When activated, it asks for:

1. Original string — text you are translating. View the plugin source code to see the exact string.
2. Text domain — woocommerce
3. Text you want to display

FAQ

Why some strings on the Checkout page are not being translated?

You may see that some of the strings are not being translated on the Checkout page. For example, in the screenshot below, Local pickup shipping method, Cash on delivery payment method and a message related to Privacy Policy are not being translated to Russian while the rest of the form is indeed translated:

This usually happens when you first install WooCommerce and select default site language (English) and later change the site language to another one. In WooCommerce, the strings that have not been translated in the screenshot, are stored in the database after the initial WooCommerce installation. Therefore, if the site language is changed to another one, there is no way for WooCommerce to detect a translatable string since these are database entries.

In order to fix it, navigate to WooCommerce settings corresponding to the string you need to change and update the translation there directly. For example, to fix the strings in our case above, you would need to do the following:

• Local pickup – navigate to WooCommerce / Settings / Shipping / Shipping Zones, select the shipping zone where Local pickup is added, open Local pickup settings, and rename the method with the actual translation. Save the setting.
• Cash on delivery – navigate to WooCommerce / Settings / Payments, select Cash on delivery payment method, open its settings, and rename the method title, description, and instructions with the actual translation. Save the setting.
• Message related to Privacy Policy – navigate to WooCommerce / Settings / Accounts & Privacy, scroll down to the Privacy policy section, and edit Registration privacy policy and Checkout privacy policy fields with the actual translation. Save settings.

Navigate back to the Checkout page – translations should be reflected there.

The post Translating WooCommerce (Localization) first appeared on CODIBU.

Change the look of how currency is shown in your WooCommerce store.

Currency

To change your shop currency settings go to: WooCommerce > Settings > General > Currency Options and select your desired currency from the Currency drop down.

• Currency – Choose the currency the store will be priced in.
• Currency Position – Choose whether the currency symbol is placed to the left or right of the price.
• Thousand Separator – Choose the character to use for the thousand separator.
• Decimal Separator – Choose the character to use for the decimal separator.
• Number of Decimals – Choose the number of digits to appear after the decimal separator.

Custom Currency

If your currency is not listed in the dropdown, you can:

• Use our tutorial on how to add your own custom currency

This is considered a customization, which is not covered under our Support Policy. Be sure you feel comfortable with code or troubleshooting your site.

Multiple Currencies

WooCommerce only allows for one base currency at a time.

There are a few options for offering multiple currencies:

• Currency Converter Widget: Change the display of prices only. This will not change the currency you charge customers, as this will still use the base currency. Using the Currency Converter Widget enables your store to run on a single currency, which simplifies store administration, accounting, and general maintenance; and helps customers to view your product catalog in their native currency, despite checking out in your set base currency.
• WooCommerce Multi-currency: Allow customers to pay in the currency of their choice.
• MultilingualPress: Display your content, products, and prices in multiple languages and currencies.

When desiring a multi-currency store, we urge you to consider the reasons you would like multiple currencies.

• If you are looking to offer multiple currencies as a way to entice buyers from specific regions, and to offer a comparative price between your currency and another, the Currency Converter Widget will aid in achieving this.
• If you are looking to customize the content of your products entirely, and to adjust the price of your products manually for each specific product (i.e., not a direct conversion, based on the exchange rate), one of the multilingual plugins above would aid with this.

Currency Exchange Rates and Extra Charges

Without the Currency Converter Widget, the customer needs to do their own research on the exchange rate and how much their bank charges to exchange currencies to pay for the order.

For example, if you travel to Europe with your US-based credit card and purchase something in Euros (the shop base currency), your bank would charge you the conversion and any international fees. The same applies to WooCommerce: The exchange rate and fees are not charged by WooCommerce; they’re charged by the customer’s bank that sets the exchange rate and associated fees.

The post Shop Currency first appeared on CODIBU.

Home Section

The Home section is your WooCommerce dashboard. Here you can stay on top of your store performance, get useful tips and insights to grow your business, and quickly access some of the most important areas to manage your store.

More information at: Home Screen.

Orders Section

The Orders section is used for viewing and managing orders. You can also manually add orders.

More information at: Managing Orders.

Customers Section

The Customers section presents a list of all your customers, with basic information such as their contact information, count of orders placed, and lifetime spend.

Reports Section

In the Reports section you can view data on sales, customer, coupons and stock.

More information at: Reports.

Settings

Contains all settings used to configure WooCommerce, including product page setup, tax, shipping and payment gateways, accounts and privacy, and emails.

More information at: Setting up WooCommerce.

Status

The Status page is a useful for troubleshooting on your own or when contacting support. Download the System Status Report and review, or attach it to your support ticket. It provides an overall snapshot of your setup and potential conflicts.

More information at: Understanding the WooCommerce System Status Report.

Extensions

The Extensions sections is where you can browse for additional free/premium plugins and extensions to add functionality and features to your site. Use the categories given, or use the Search loop.

Products Menu

This top-level menu has sections relating to products, such as viewing and adding new products, setting up product categories and tags, and managing product attributes.

More information at: Managing Products.

The post WooCommerce Menu Items first appeared on CODIBU.

You’ll find information about configuring General WooCommerce settings as well as Product, Tax, Payments, Shipping, Accounts, Email, API, and Webhooks.

To get started, go to WooCommerce > Settings.

General Settings

Store address

Defines your shop’s address country and state, where you are based as a seller. It determines default tax rates and customer locations.

General options

Selling Location(s)
Choose to sell to all countries or to specific countries. You can choose multiple specific countries or states.

Shipping Location(s)
Choose to ship to only those countries you sell to or a subset of countries. You can disable shipping and all shipping-related functionality.

Default Customer Address
Choose the location we assume site visitors are in, before they enter it, to calculate tax and shipping.

• Shop base address tells the system to assume they are in the same location as your shop.
• No address gives them no location, so no taxes are calculated until they provide an address.
• Geolocate address verifies where their current location and calculate taxes accordingly.
• Geolocate with page caching support is the same as above, but does the geolocation via Ajax. You may notice your website URLs have a ?v=xxxxx appended to them. This is normal to prevent static caching of prices.

Enable Taxes
Enable or disable taxes on your store. Disabling taxes hides the tax settings page.

Enable coupons
Enable or disable coupons on your store. Coupons can be applied from the admin edit order screen (for unpaid orders), cart and checkout pages.

• Enable the use of coupon codes – Select to enable the use of coupons in your store.
• Calculate coupon discounts sequentially – Changes the coupon calculation logic to apply coupons in sequence on top of one another, rather than basing them on the original product prices.

Currency options

Options that affect how prices are displayed on the frontend.

Currency
Choose the default currency for the store. Only one may be selected.

Currency Position
Choose the default currency position for prices: Left, Right, Left/Right with space

Thousand Separator
Choose the symbol to use for the thousand separator: 1,000 or 1.000

Decimal Separator
Choose the symbol to use for the decimal separator: 100.00 or 100,00

Number of Decimals
Choose how many numbers to display to the right of the decimal when displaying prices: 100.00 or 100

Products Settings

Settings for products and how they are displayed, including image sizes, inventory and downloadable product settings.

General

In the General section are Shop Pages, Measurements and Reviews, allowing you to control checkout settings, select units of measurement, and enable/disable product reviews and ratings.

Go to: WooCommerce > Settings > Products > General:

Shop pages

Shop Page
Select what page you want to be the default shop page. Need not be the Shop page that WooCommerce installed, or can be skipped if you use another method to display products.

Add to cart behavior

• Redirect to cart page after successful addition – Automatically takes the customer to the cart page upon adding a product.
• Enable Ajax add to cart buttons on archives – Adds the ‘Add to Cart’ option to shop archive pages.

Placeholder Image

Set a default ‘placeholder’ image to appear on the front end when no other image is available. This could be your brand logo or an image of a signature product or service.

Measurements

Select a unit of measurement for weight and dimension of products from the dropdown.

Reviews

Enable Reviews

• Enable product reviews
• Select whether to display if the reviewer bought the product
• Control if anyone can leave a review or only buyers

Product Ratings

• Enable stars on reviews.
• Select whether it’s required or optional

Inventory Options

To edit your shop’s inventory options, go to: WooCommerce > Settings > Products > Inventory.

Choose whether to enable stock management. If selected, you have these options:

• Manage stock
  • Enable stock management – Inventory for physical products is auto-managed. You enter quantity, and WooCommerce subtracts items as sales are made, displaying: Stock, Out of Stock or On Backorder. More info at: Stock Management Improvements.
  • Disable (box left unticked) – Inventory and status for physical products must be entered manually. You can still Enable Stock Management on a per-product level if desired. More info at: Managing Products.
• Hold Stock (minutes) – Hold products (for unpaid orders) for X minutes. When limit is reached, the pending order is canceled. Leave blank to disable. Please note that this will work for orders in the “Pending payment” status, but not “On hold”.
• Notifications
  • Enable low stock notifications
  • Enable out of stock notifications
• Notification Recipient – Enter email address for notifications.
• Low Stock Threshold – Number of products to trigger low stock notification
• Out Of Stock Threshold – Number of products to trigger out of stock status.
• Out Of Stock Visibility – Choose to hide out of stock items from catalog.
• Stock Display Format
  • Always show stock – “12 in stock”
  • Only show stock when low – “Only 2 left in stock” vs. “In stock”
  • Never show amount

Downloadable Products

Go to: WooCommerce > Settings > Products > Downloadable products.

File Download Method
Controls how your store provides downloadable files to purchasers.

• Force Downloads – Files are ‘forced’ to download via a PHP script. Files are not accessible to anyone but purchasers, and direct links are hidden.
• X-Accel-Redirect/X-Sendfile – Similar to ‘forced’ above, but it has better performance and can support larger files. It requires that your hosting provider supports either X-Sendfile or X-Accel-Redirect, so you need to check with them first.
• Redirect only – A download URL links the user to the file. Files are not protected from outside access.

Most stores should use one of first two methods to keep files safe from outside access. Redirect should only be used if you encounter problems or don’t mind downloads being non-secure.

Access Restriction

• Select if downloads require login – Does not apply to guest purchases.
• Grant access to downloadable products after payment – Enable to grant access to downloads when orders are Processing, rather than Completed.

Tax Settings

Go to: WooCommerce > Settings > Tax.

Taxes are very important and complex enough that we’ve written more about them in their own section of our docs. More at: WooCommerce Tax Settings.

Shipping Settings

Go to: WooCommerce > Settings > Shipping.

The main shipping settings screen is for Shipping Zones. Think of a shipping zone as a geographic region where a certain set of shipping methods and their rates apply.

You can read about setting up shipping zones at: Setting up Shipping Zones

Shipping Options

Shipping Calculations

• Enable the shipping calculator on the cart page
• Hide shipping costs until an address is entered

Shipping Destination
Ship to billing address or customer shipping address by default or only ship to the user’s billing address.

Debug Mode
Enable for troubleshooting purposes.

Payments Settings

Go to: WooCommerce > Settings > Payments to control which payment gateways are enabled.

Installed gateways are listed and can be dragged and dropped to control the order in which they display to customers on the checkout.

Clicking the name of the payment gateway will take you directly to a screen to set up or adjust your settings.

Another way to configure settings is to select Set Up or Manage. You can also use the Enabled toggle to turn a gateway on or off:

If you try to enable a payment method that needs extra configuration, it will redirect you to the payment methods setup screen.

More information about:

• Premium Payment Gateway options.
• Free Payment Gateways included in WooCommerce.

Accounts and Privacy Settings

Go to WooCommerce > Settings > Accounts and Privacy to control options relating to customer accounts and data retention.

Guest Checkout

• Allow customers to place orders without an account – Allows customers to check out without creating an account. Orders will not be tied to a user account in WordPress.
• Allow customers to log into an existing account during checkout – This displays a login form and prompt on the checkout page if the customer is not already logged in.

Account Creation

• Allow customers to create an account during checkout
• Allow customers to create an account on the My account page
• Automatically generate username from customer email – If this is disabled, there will be an input box for the user to create their own username.
• Automatically generate customer password – If this is disabled, there will be an input box for the user to create their own password. Note that while the password strength notification will be displayed, customers can choose any password so as to not limit conversions.

Account erasure requests

• Remove personal data from orders – WordPress 4.9 allows you to remove personal data on request. When doing this, if you enable this option, user data will also be removed from your orders if they belong to the user being erased.
• Remove access to downloads – WordPress 4.9 allows you to remove personal data on request. When doing this, if you enable this option, download data will also be removed if it belongs to the user being erased. The erased user will no longer have access to any purchased downloads if this happens.

Personal data removal

• Allow personal data to be removed in bulk from orders – Adds a new bulk action to remove personal data on the Orders page. Useful if you need to manually anonymize orders in bulk.

Privacy policy

This section lets you select a page for your privacy policy, and display privacy policy snippets on your account and checkout pages shown to customers. These settings were added in WooCommerce 3.4.

• Privacy Page – Select a page to act as your privacy policy. Using [privacy_policy] will link to this page. Some themes also use this option to link to a privacy policy in other places, such as the footer. This feature was added in WordPress 4.9.
• Registration privacy policy – Shown on the registration form on the My Account page. You should include information about your privacy policy, and link to your page privacy policy page for more information.
• Checkout privacy policy – Shown on the checkout form. You should include information about your privacy policy, and link to your page privacy policy page for more information.

Personal data retention

This section allows you decide how long to keep order data on your store. You should specify how long your site will retain data in your privacy policy; consider what makes sense for local laws such as the EU GDPR. These settings were added in WooCommerce 3.4.

For each option, enter a number and choose the duration from days, weeks, months, or years. Leaving these options blank will disable them.

• Retain inactive accounts – Inactive accounts are accounts which have not logged in nor placed an order for the specified duration.
• Retain pending orders – Pending orders are unpaid or abandoned and should not need to be fulfilled.
• Retain failed orders – Failed orders are unpaid or abandoned and should not need to be fulfilled.
• Retain cancelled orders – Cancelled orders were orders cancelled on purpose by either the admin or the customer, or timed out waiting for payment.
• Retain completed orders – Completed orders were fulfilled in the past.

Personal Data Exporter

WordPress 4.9.6 has the ability to export personal data associated with an email address to an HTML file. WooCommerce adds to the generated export file, exporting the following data:

• Customer address/account information
• Orders associated with the given email address
• Download permissions and logs associated with the given email address

To ensure requests are genuine, a confirmation email is sent to verify the request. The verification process:

1. Enter an email address or username.
2. User is notified via email with a confirmation link.
3. Confirmation link is used, and request is marked “confirmed.”
4. Email with link to download their personal data is sent to the user.

Example of a Personal Data File:

Email Settings

Options available to edit email settings and templates.

Go to: WooCommerce > Settings > Emails.

Email notifications

For each WooCommerce email listed, it’s possible to configure your settings (optional). More detailed instructions below in: Editing Individual Email Templates.

Email Sender Options

Set the ‘From’ name and email address for the sender.

Email Templates

This section lets you customize WooCommerce emails.

Header Image
Enter the URL of an image you want to show in the email header. You can upload an image via the Add Media button or Media > Add New.

Email and Text

• Base Color – Color for WooCommerce email templates.
• Background Color – Background color for WooCommerce email templates.
• Email Body Background Color – Main body background color.
• Email Body Text Color – Main body text color.

For more advanced control, copy the woocommerce/templates/emails/ folder to yourchildtheme/woocommerce/emails/.

We recommend keeping customizations in a child theme, so changes are not overwritten when performing updates More at: How to set up and use a child theme.

Editing Individual Email Templates

In the list above in Email Notifications are these templates:

New order | Cancelled order | Failed order | Processing order | Completed order | Refunded order | Customer invoice | Customer note | Reset password | New account

Select Manage on the right side, and a new screen appears.

New order

Select options or enter preferences:

Enable/Disable
Enable this email notification.

Recipient(s)
Enter recipients (comma separated) for this email. Defaults to info@woocommerce.com.

Subject
This controls the email subject line. Leave blank to use the default subject:

[{site_title}] New customer order ({order_number}) - {order_date}

Email Heading
This controls the main heading contained within the email notification. Leave blank to use the default heading.

Email type
Choose which format of email to send. Options include:

• Plain Text
• HTML
• Multipart

If using Plain Text emails, keep in mind that text fields are limited to 155 characters. If your products have long names and/or numerous variations/add-ons, the field may be truncated.

HTML template
To override and edit this email template, copy woocommerce/templates/emails/admin-new-order.php to your theme folder: yourchildtheme/woocommerce/emails/admin-new-order.php. You can also copy the template file or view it on this setting screen.

Save any changes.

Completed order and Customer invoice / order details 

The Completed order and Customer invoice/ Order details templates have slightly different settings from others.

• Customer invoice/Order details cannot (and should not) be disabled.
• Both templates have ‘Thanks’ fields that can be altered.

Advanced Settings

Advanced settings allow you to change WooCommerce defaults and integrate with the API.  Go to: WooCommerce > Settings > Advanced.

Page Setup

Pages need to be set so WooCommerce knows where to send users to perform certain actions:

• Cart Page – This page shows items in your customers cart.
• Checkout Page – This page is where your customer will enter their payment information and submit orders.
• My Account page – This page is where registered customers will go to view their orders or update their account details.
• Terms and Conditions – This page shows terms and conditions.
• Secure checkout – Force SSL (HTTPS) on the checkout pages. An SSL Certificate is required, if selected.

You need not use the pages WooCommerce installed, but you must have a page set for the Cart and Checkout pages. Otherwise your customers cannot buy and pay for your products. These pages are normally created and set when installing/setting up WooCommerce.

To use a Terms and Conditions page, create a new page for it at Pages > Add New, then select the page in the dropdown. The Terms and Conditions appear inline during checkout, and the customer can scroll through content and tick the checkbox to accept.

Checkout Endpoints

Endpoints are appended to page URLs to handle specific actions during the checkout process. They should be unique. Learn more about WooCommerce endpoints.

My Account Endpoints

Endpoints are appended to your page URLs to handle specific actions on the accounts pages. They should be unique.

• Orders
• View Order
• Downloads
• Edit Account
• Addresses
• Payment Methods
• Lost Password
• Logout

Learn more about WooCommerce Endpoints.

Rest API

Go to: WooCommerce > Settings > Advanced > REST API. Here you can create API keys to work with the WooCommerce REST API. More info at: Generate API Keys.

This API is for developers to use. You can enable it to access store data from outside WordPress, e.g., Our iOS app or other external apps. More information at: WooCommerce REST API.

Webhooks

More info at: Using WooCommerce Webhooks.

Legacy API

Enable the Legacy REST API which is no longer maintained.

The post Configuring WooCommerce Settings first appeared on CODIBU.

Permalink is short for “permanent link.” Permalinks are permanent URL structures used to help organize the content of your website (pages, posts, products, etc.) so it can be efficiently navigated, shared, and referenced by users and bots.

Permalink settings for WooCommerce can be found at WordPress > Settings > Permalinks.

From here you can configure the URL structure for your shop and product pages.

For best practice, permalink structures should contain keywords relating to the content they help categorize.

Taxonomy Permalinks

There are three settings at WordPress > Settings > Permalinks > Optional that control the base of your categories, terms, and attributes on WooCommerce:

• Product category base – The default product category base is product-category. An example would be yourdomain.com/product-category/category-name.
• Product tag base – The default product tag base is product-tag. An example would be yourdomain.com/product-tag/tag-name.
• Product attribute base – The default product attribute base will optionally use a custom base before /attribute-name/attribute/. An example without anything set would be yourdomain.com/size/medium or yourdomain.com/color/blue. If you set a custom base, an example would be yourdomain.com/attribute/size/medium where attribute is designated for the base.

Product Permalinks

There are four settings under WordPress > Settings > Permalinks > Product Permalinks to select from as your permalink base for products:

• Default – If you are not using pretty permalinks, Default will be the only option available to you and will use ID-based URLs. An example would be yourdomain.com/?product=111. If you are using pretty permalinks, the product base will be yourdomain.com/product/product-name.
• Shop base – The shop base will use the shop page name. An example would be yourdomain.com/shop/product-name.
• Shop base with category – The shop base with category will use the shop page name first, then add the product category name. An example would be yourdomain.com/shop/product-category-name/product-name.
• Custom base – The custom base will allow you to set custom text before the product name. An example would be yourdomain.com/custom-text/product-name.

Note: The product Custom base setting should NOT conflict with the Taxonomy permalink settings. If you set the product base to shop for example, you should NOT set the product category base to shop too, as this will not be unique and cause a conflict. WordPress requires something unique so it can distinguish categories from products.

The post Permalinks first appeared on CODIBU.

• manage_woocommerce for WooCommerce Settings
• view_woocommerce_reports

Customer role

People become Customers when registering via the checkout or sign-up process.

Customers:

• Have read access only for most capacities. This is the equivalent status to a normal blog subscriber.
• Can edit their own account information.
• View past/present orders.

Shop Manager role

Shop Manager is a role you can give someone to manage the shop without making them an Admin. They have all the rights a customer has, and are granted the main capabilities:

• manage_woocommerce: Gives shop managers the option to manage all settings within WooCommerce, and create/edit products.
• view_woocommerce_reports: Gives them access to all WooCommerce reports.

The Shop Manager role has all the capabilities listed at our WooCommerce GitHub repo.

They also have general WordPress editor capabilities.

Tweaking capabilities

If you wish to modify roles and capabilities, use a third-party plugin such as:

• Capability Manager Enhanced
• Members
• Groups

The post Roles and Capabilities first appeared on CODIBU.

System Status

To view your System Status report:

1. Go to: WooCommerce > Status.
2. Troubleshoot using the info below, before opening a ticket at Woo Support.
3. Select Get System Report and copy/paste it into your Support Ticket, if you’re still having issues. The information included will help our support team narrow down the issue much quicker.

WordPress Environment

This provides general information about your site and WordPress installation and features you have enabled.

FIELD NAME	DESCRIPTION	EXAMPLE
WP address (URL)	URL of your site’s homepage.	https://example.com
Site address (URL)	Root URL of your site.	https://example.com
WC Version	Version of WooCommerce installed on your site.	4.0.0
WC REST API package	Version of WooCommerce REST API package installed on your site.	1.0.7 /srv/htdocs/wp-content/plugins/woocommerce/packages/woocommerce-rest-api
WC Blocks package	Version of WooCommerce Blocks package installed on your site.	2.5.13 /srv/htdocs/wp-content/plugins/woocommerce/packages/woocommerce-blocks/
Action Scheduler package	Version of Action Scheduler package installed on your site.	3.1.1 /srv/htdocs/wp-content/plugins/woocommerce/packages/action-scheduler
WC Admin package	Version of WooCommerce Admin package installed on your site.	0.24.0 /srv/htdocs/wp-content/plugins/woocommerce-admin
Log Directory Writable	Whether the WooCommerce log directory is writable, and the location.	/srv/www/wp-content/uploads/wc-logs/
WP Version	Version of WordPress installed on your site.	4.7.3
WP Multisite	Whether you have WordPress Multisite enabled.	No
WP Memory Limit	Maximum memory (RAM) that your site can use at one time. Learn how to increase this limit here.	256 MB
WP Debug Mode	Displays whether WordPress is in Debug Mode.	–
WP Cron	Displays whether WordPress Cron is enabled.
Language	Current language used by WordPress. Default = English	en_US
External Object Cache	Whether WordPress is using an external cache.

Server Environment

This provides general information about your server.

FIELD NAME	DESCRIPTION	EXAMPLE
Server Info	Information about the webserver currently hosting your site.	nginx / apache
PHP Version	Version of PHP installed on your hosting server.	7.0.17
PHP Post Max Size	Largest file size that can be contained in one post.	1 GB
PHP Time Limit	Amount of time in seconds that your site spends on a single operation before timing out (to avoid server lockups).	1200
PHP Max Input Vars	The maximum number of variables your server can use for a single function to avoid overloads.	6144
cURL Version	Version of cURL installed on your server, if any.	7.68.0, OpenSSL/1.1.0l
SUHOSIN Installed	Suhosin is an advanced protection system for PHP installations. It was designed to protect your servers against a number of well-known problems in PHP applications; and also against potential unknown vulnerabilities within these applications or the PHP core itself. If enabled on your server, Suhosin may need to be configured to increase its data submission limits. More info at: Data not saving variations and rates.	–
MySQL Version	Version of MySQL installed on your hosting server.	5.6.47-13.1.20
Max Upload Size	Largest file size that can be uploaded to your WordPress installation.	2GB
Default Timezone is UTC	Whether the timezone for your server is UTC.
fsockopen/cURL	Payment gateways can use cURL to communicate with remote servers to authorize payments. Other plugins may also use it when communicating with remote services.
SoapClient	Some Web services use SOAP to get information from remote servers, e.g., Live shipping quotes from FedEx require SOAP be installed.
DOMDocument	HTML/Multipart emails use DOMDocument to generate inline CSS in templates.
GZip	GZip (gzopen) is used to open the GEOIP database from MaxMind.
Multibyte String	Multibyte String (mbstring) functions are used to support UTF-8 characters.
Remote Post	PayPal uses this method of communication when sending back transaction information. More info at: wp_remote_post Codex page.
Remote Get	WooCommerce plugins may use this method of communication when checking for updates.

Database

This tells you your current database version, and lists all database tables and whether or not they exist.

FIELD NAME		EXAMPLE
WC Database Version Version of WooCommerce that the database is formatted for.		3.7.0
Database prefix		wp_
Total Database Size		2.06MB
Database Data Size		8.48MB
Database Index Size		2.21MB
wp_actionscheduler_actions		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_actionscheduler_claims		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_actionscheduler_groups		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_actionscheduler_logs		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_woocommerce_sessions
wp_woocommerce_api_keys		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_woocommerce_attribute_taxonomies		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_woocommerce_downloadable_product_permissions		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_woocommerce_order_items		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_woocommerce_order_itemmeta		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_woocommerce_tax_rates		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_woocommerce_tax_rate_locations		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_woocommerce_shipping_zones		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_woocommerce_shipping_zone_locations		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_woocommerce_shipping_zone_methods		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_woocommerce_payment_tokens		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_woocommerce_payment_tokenmeta		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_woocommerce_log		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_commentmeta		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_comments		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_failed_jobs		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_links		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_options		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_postmeta		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_posts		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_queue		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_termmeta		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_terms		Data:0.02MB + Index: 0.05MB + Engine InnoDB
wp_term_relationships		Data:0.02MB + Index: 0.02MB + Engine InnoDB
wp_term_taxonomy		Data:0.02MB + Index: 0.01MB + Engine InnoDB
wp_usermeta		Data:0.02MB + Index: 0.02MB + Engine InnoDB
wp_users		Data:0.02MB + Index: 0.01MB + Engine InnoDB

Post Type Counts

This shows what post types exist on your store and how many posts exist within each type. Varies according to what plugins you have installed.

Security

Displays whether your connection is protected. Errors should be hidden from untrusted visitors trying to view your information.

SECURITY
Secure connection (HTTPS):	Is the connection to your store secure?
Hide errors from visitors	Error messages can contain sensitive information about your store environment. These should be hidden from untrusted visitors.

Active Plugins

This displays all plugins installed and active on your site. You can view current version numbers of your software and if any extensions have updates available.

Inactive Plugins

This displays all plugins installed but inactive on your site. You can view current version numbers of your software and if any extensions have updates available.

Dropin Plugins

These are in the wp-content but only specific file names. They replace/augment very specific functionality within WordPress.

Settings

This shows general settings for your site.

FIELD NAME	DESCRIPTION	EXAMPLE
API Enabled	Does your site have REST API enabled?
Force SSL	Does your site force an SSL certificate for transactions?
Currency	What currency are prices displayed in and payments processed in	USD ($)
Currency Position	Position of the currency symbol when displaying prices.	left
Thousands Separator	Character used for a thousands separator in displayed prices.	,
Decimal Separator	Character used for decimal points in displayed prices.	.
Number of Decimals	Places shown after decimal points in displayed prices.	2
Taxonomies: Product types	Terms used for product types/statuses	booking, bundle, external, grouped, simple, subscription, variable
Taxonomies: Product visibility	A list of terms used for product visibility.	exclude-from-catalog, exclude-from-search, featured, outofstock, rated-1, rated-2, rated-3, rated-4, rated-5.
Connected to WooCommerce.com	Are your sites connected to WooCommerce.com?

WooCommerce Pages

This shows page IDs and Permalinks designated as WooCommerce pages.

For example: If your site is https://example.com, a user would get to the Cart page by going to https://example.com/cart/

Theme

This displays information about the current theme running on your installation.

This could be a more problematic area of a site, as there is no standard on what themes should and should not do, and non-Woo themes can cause conflicts with WooCommerce or one of its extensions.

If you’re experiencing issues with your site, we recommend temporarily switching to the free Storefront Theme. If your problem is resolved while the Storefront theme is active, then the issue is with the theme. To resolve, check for updates or contact the theme developer to see if there is a fix.

FIELD NAME	DESCRIPTION	EXAMPLE
Name	Name of the active theme.	Storefront
Version	Installed version of the current active theme.	2.5.5
Author URL	Developer or theme URL	https://woocommerce.com
Child Theme	Whether the active theme is a child theme, and what the parent theme is.	x
WooCommerce Support	Whether the theme declares WooCommerce support.

Templates

This section shows any files that are overriding the default WooCommerce template pages, and also notes if the templates are outdated.

If you are experiencing trouble with any of the pages displayed, switching to the Storefront theme will ensure that the original template files are used. For more information, see Fixing Outdated WooCommerce Template Files. For a long-term fix, you need to contact the theme developer.

Subscriptions

Action Scheduler

This shows scheduled action counts with previous and most recent dates. For more technical information about the Action Scheduler and FAQ, please see ActionScheduler.org.

Tools

In the Tools tab are helpful buttons that can address items such as user capabilities and customer sessions.

With transients, you can clear both WooCommerce transients and all expired transients from WordPress with the Clear transients and the Clear expired transients buttons. Transients are a standardized way to store cached data temporarily in the database.

If you have a collection of variations that don’t have a parent you can remove those with one click using the Delete orphaned variations button. You can then order address indexes, which can help improve order search results.

Following that, you can recount terms and reset capabilities. Recounting terms can be useful if you change any settings that hide products from the catalog and have issues from that. And if you find any users that can’t access all of the WooCommerce admin pages, resetting capabilities can be used in that case.

Clear customer sessions will remove any session data from the database. This includes any carts your customers are currently working on so use with caution.

Our next useful tool is the Create default WooCommerce pages button, if you’re having issues with WooCommerce pages or don’t want to create them one by one again you can select Install pages and it will create any missing WooCommerce pages. Pages already defined and set up won’t be replaced.

After that, you can delete all the tax rates you’ve set in WooCommerce. If you were going to delete them anyway use this tool versus going through each tax class and remove those rates one by one.

Finally, you can delete WebHook logs and reset the usage tracking settings. When you first installed WooCommerce you may have opted in to send us non-sensitive data that helps us make WooCommerce better for everyone. You can opt-out now by resetting your usage tracking settings.

Logs

The Logs tab is where WooCommerce keeps logs of all events happening in your store.

In the dropdown, you can choose the level of logs you want to see, then select the Filter button to see events captured there. This can be useful to get exact errors with timestamps on parts of your store.

If your site experiences a fatal error, they may be logged here under a log named fatal-errors. This is useful when debugging.

By default, logs are kept for 30 days before being purged as of WooCommerce 3.4. This can be changed using the woocommerce_logger_days_to_retain_logs filter which defaults to 30.

WooCommerce Services

Users of WooCommerce Services have a fifth tab that allows you to check the health of Services, specific Services in use, a debugging section, and more.

Health displays the status of connected parts – if anything with WooCommerce or Jetpack needs attention, and if Services is up or down.

Services display how specific Services are doing. Perhaps they’re unused, have an error needing attention, or working fine. You can enable debug logging to capture issues, and also contact our Support team to help configure your printer for printing shipping labels.

The post Understanding the WooCommerce System Status Report first appeared on CODIBU.

A Webhook is an event notification sent to a URL of your choice. Users can configure them to trigger events on one site to invoke behavior on another.

Webhooks are useful for integrating with third-party services and other external API that support them.

Webhooks in WooCommerce

Webhooks were introduced in WooCommerce 2.2 and can trigger events each time you add, edit or delete orders, products, coupons or customers.

It’s also possible to use webhooks with WooCommerce actions, e.g., Create a webhook to be used every time a product is added to the shopping cart, using the action woocommerce_add_to_cart.

Webhooks also make it easier for third-party apps to integrate with WooCommerce.

Creating webhooks

To create a new webhook:

1/ Go to: WooCommerce > Settings > Advanced > Webhooks.
Note: Webhooks were formerly found under WooCommerce > Settings > API prior to WooCommerce 3.4.

2/ Select Create a new webhook (first incident) or Add webhook. The Webhook Data box appears.

3/ Enter.

• Name: The name is auto-generated as “Webhook created on [date and time of creation]” as a standard to facilitate creation. Change the name to something else.
• Status: Set to Active (delivers payload), Paused (does not deliver), or Disabled (does not deliver due delivery failures).
• Topic: Indicate when the webhook should be triggered – Order Created, Product Deleted, or Customer Updated. There are also Action and Custom options.
  • Action Event: This option is available when the Topic is a WooCommerce Action, such as woocommerce_add_to_cart for when customers add products to the shopping cart.
  • Custom Topic: This option is for advanced users only. It’s possible to introduce new, customized topics with the help of woocommerce_webhook_topic_hooks filter.
• Delivery URL: URL where the webhook payload is delivered.
• Secret: The Secret Key generates a hash of the delivered webhook and is provided in the request headers. This defaults to the current API user’s consumer secret, if nothing is entered.

4/ Save Webhook.

Editing and deleting webhooks

Webhooks are listed the same way as posts or products.

1. Find the webhook you wish to alter.
2. Hover over the name, and Edit and Delete permanently options appear.
3. Delete, or make Edits and Save changes. Bulk deletion is also possible with the dropdown.

Webhook logs

WooCommerce saves logs of all events triggering a webhook. Webhook logs are found at: WooCommerce > Status > Logs.

Logs may be reviewed to see delivery and response from the server, making it simpler to integrate and debug.

The post Using Webhooks first appeared on CODIBU.