Documentation

Learn how to set up, customize, and expand the functionality of WooCommerce

Developer Documentation


Documents

  • Actions

    woocommerce_product_search_deactivate This action is invoked when the plugin is about to be deactivated and before it deletes its own data. It does not imply that its data will be deleted. woocommerce_product_search_indexer_index_start This action is triggered before the search engine’s indexer starts indexing a product. The action provides one argument, the product’s ID. Arguments: $post_id int […]

  • API

    Please refer to the following sections where we provide details on how to debug issues and describe the functions and hooks provided by the WooCommerce Product Search extension’s API.  

  • Constants

    The constants documented here can be defined in your site’s wp-config.php. For constants related to debugging, please refer to Debugging. Disabling Back End and JSON Searches The General settings provide options to power back end and JSON product searches. The settings can be overridden by setting the following constant: define( ‘WPS_EXT_PDS’, false ); While the […]

  • Customization

    This section of the documentation is aimed at developers who are familiar with WordPress theme customizations and who know their way around HTML and CSS. To a certain extent, you might also want to be familiar with child themes for WooCommerce, the section Set up and use a child theme in the documentation can help […]

  • Debugging

    The constants documented here can be defined in your site’s wp-config.php. For other constants that you can use to fine-tune certain aspects of the search engine, please refer to the section on Constants. How to enable Debugging Add the following lines in wp-config.php to have general PHP and WordPress warnings, error messages and status information […]

  • Events

    ixProductFilterRequestProcessed This jQuery event is hooked on the document and is triggered after a filter request response has been processed. This will typically involve a change to the set of products displayed, according to the current filter context. This event can be useful in post-processing, after a filter request has been attended. For example, some […]

  • Examples

    Search Form in PHP templates Use the woocommerce_product_search() function to render the search facility in PHP templates. This function accepts an array of options as described for the shortcode. See the page Shortcodes for details on the parameters that can be passed to this function. Example code: <?php if ( function_exists( ‘woocommerce_product_search’ ) ) { echo woocommerce_product_search( […]

  • Filters

    product_search_limit This filter allows to alter the limit on the number of results produced for the Product Search Field. Arguments: Return: int the number of results single_term_title Allows to modify the category name displayed for categories shown on the Product Search Field. Arguments: Return: string the category name widget_title Allows to modify the widget title […]

  • Product Filter – Attributes

    This section focuses on styling our product attribute filters, which are produced by the Product Filter – Attributes widget, its equivalent [woocommerce_product_filter_attribute] shortcode or the API function. We will be exploring the structural HTML elements and related CSS and learn how to apply customizations that allow to change the appearance of the elements involved. For this […]

  • Product Filter – Categories

    This section of the tutorial focuses more on styling the Product Filter – Categories. We will be exploring how to change the look and feel of the Product Filter – Categories. Though we assume you know your way around with CSS rules, here are some good resources to help refresh your mind on CSS rules and […]

Use of your personal data
We and our partners process your personal data (such as browsing data, IP Addresses, cookie information, and other unique identifiers) based on your consent and/or our legitimate interest to optimize our website, marketing activities, and your user experience.