wpseo_canonical

Filter: 'wpseo_canonical' - Allow filtering of the canonical URL put out by Yoast SEO.

Description

apply_filters( 'wpseo_canonical', (unknown) $canonical ); 

Parameters (1)

0. $canonical (unknown)
The canonical.

Usage

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

Defined (1)

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

/frontend/class-frontend.php  
  1. $this->canonical = apply_filters( 'wpseo_canonical', $canonical );