woocommerce_pagination_args

The WordPress Core woocommerce pagination args hook.

Description

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

Parameters (1)

0. $array — Optional. (callback) => array( 'base' => esc_url_raw(str_replace(999999999, '%#%', remove_query_arg('add-to-cart', get_pagenum_link(999999999, false)))), 'format' => '', 'current' => max(1, get_query_var('paged')), 'total' => $wp_query->max_num_pages, 'prev_text' => '←', 'next_text' => '→', 'type' => 'list', 'end_size' => 3, 'mid_size' => 3 )
The array.

Usage

To run the hook, copy the example below.
  1. $array = apply_filters( 'woocommerce_pagination_args', $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_pagination_args callback 
  2. function filter_woocommerce_pagination_args( $array ) { 
  3. // make filter magic happen here... 
  4. return $array
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'woocommerce_pagination_args', 'filter_woocommerce_pagination_args', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'woocommerce_pagination_args', 'filter_woocommerce_pagination_args', 10, 1 ); 

Defined (1)

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

/woocommerce/loop/pagination.php  
  1. echo paginate_links(apply_filters('woocommerce_pagination_args', array(