pll_check_canonical_url

Filters the canonical url detected by Polylang.

Description

apply_filters( 'pll_check_canonical_url', (bool|string) $redirect_url, (object) $language ); 

Parameters (2)

0. $redirect_url (bool|string)
False or the url to redirect to
1. $language (object)
The language detected

Usage

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

Defined (1)

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

/frontend/frontend-filters-links.php  
  1. $redirect_url = apply_filters( 'pll_check_canonical_url', $redirect_url, $language );