woocommerce_default_catalog_orderby
The WordPress Core woocommerce default catalog orderby hook.
Description
Parameters (1)
- 0. $get_option (unknown) =>
get_option( 'woocommerce_default_catalog_orderby' )
- The get option.
Usage
- To run the hook, copy the example below.
- $get_option = apply_filters( 'woocommerce_default_catalog_orderby', $get_option );
- if ( !empty( $get_option ) ) {
- // everything has led up to this point...
- }
- The following example is for adding a hook callback.
- // define the woocommerce_default_catalog_orderby callback
- function filter_woocommerce_default_catalog_orderby( $get_option ) {
- // make filter magic happen here...
- return $get_option;
- };
- // add the filter
- add_filter( 'woocommerce_default_catalog_orderby', 'filter_woocommerce_default_catalog_orderby', 10, 1 );
- To remove a hook callback, use the example below.
- // remove the filter
- 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/class-wc-query.php
- $orderby_value = isset( $_GET['orderby'] ) ? wc_clean( $_GET['orderby'] ) : apply_filters( 'woocommerce_default_catalog_orderby', get_option( 'woocommerce_default_catalog_orderby' ) );
- /includes/wc-template-functions.php
- $orderby = isset( $_GET['orderby'] ) ? wc_clean( $_GET['orderby'] ) : apply_filters( 'woocommerce_default_catalog_orderby', get_option( 'woocommerce_default_catalog_orderby' ) );
- $show_default_orderby = 'menu_order' === apply_filters( 'woocommerce_default_catalog_orderby', get_option( 'woocommerce_default_catalog_orderby' ) );