woocommerce_catalog_orderby

The WooCommerce woocommerce catalog orderby hook.

Description

apply_filters( 'woocommerce_catalog_orderby', (callback) $array ); 

Parameters (1)

0. $array — Optional. (callback) => array( 'menu_order' => __( 'Default sorting', 'woocommerce' ), 'popularity' => __( 'Sort by popularity', 'woocommerce' ), 'rating' => __( 'Sort by average rating', 'woocommerce' ), 'date' => __( 'Sort by newness', 'woocommerce' ), 'price' => __( 'Sort by price: low to high', 'woocommerce' ), 'price-desc' => __( 'Sort by price: high to low', 'woocommerce' ), )
The array.

Usage

To run the hook, copy the example below.
  1. $array = apply_filters( 'woocommerce_catalog_orderby', $array ); 
  2.  
  3. if ( !empty( $array ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the woocommerce_catalog_orderby callback 
  2. function filter_woocommerce_catalog_orderby( $array ) { 
  3. // make filter magic happen here... 
  4. return $array
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'woocommerce_catalog_orderby', 'filter_woocommerce_catalog_orderby', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'woocommerce_catalog_orderby', 'filter_woocommerce_catalog_orderby', 10, 1 ); 

Defined (1)

The filter is defined in the following location(s).

/includes/wc-template-functions.php  
  1. $catalog_orderby_options = apply_filters( 'woocommerce_catalog_orderby', array(