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 […]

• ANZ eGate

  The ANZ eGate plugin allows you to take payments directly on your WooCommerce store via the ANZ eGate payment processor. Installation Unzip and upload the plugin’s folder to your /wp-content/plugins/ directory Activate the extension through the ‘Plugins’ menu in WordPress Go to: WooCommerce > Settings > Payment Gateways > ANZ eGate to configure the plugin To learn […]

• 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 […]

• Functions

  All of the following functions take an optional array as their function argument, holding options equivalent to those that the Shortcodes allow. Please refer to documentation of the corresponding shortcode for details on the accepted attributes. All functions return a string which can be used to render the corresponding HTML in a PHP template. woocommerce_product_search() […]