woocommerce_default_catalog_orderby

The WooCommerce woocommerce default catalog orderby hook.

Description

apply_filters( 'woocommerce_default_catalog_orderby', (unknown) $get_option ); 

Parameters (1)

0. $get_option (unknown) => get_option( 'woocommerce_default_catalog_orderby' )
The get option.

Usage

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

Defined (3)

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

/includes/wc-template-functions.php  
  1. $orderby = isset( $_GET['orderby'] ) ? wc_clean( $_GET['orderby'] ) : apply_filters( 'woocommerce_default_catalog_orderby', get_option( 'woocommerce_default_catalog_orderby' ) ); 
  1. $show_default_orderby = 'menu_order' === apply_filters( 'woocommerce_default_catalog_orderby', get_option( 'woocommerce_default_catalog_orderby' ) ); 
/includes/class-wc-query.php  
  1. $orderby_value = isset( $_GET['orderby'] ) ? wc_clean( $_GET['orderby'] ) : apply_filters( 'woocommerce_default_catalog_orderby', get_option( 'woocommerce_default_catalog_orderby' ) );