page_link

Filters the permalink for a page.

Description

apply_filters( 'page_link', (string) $link, (int) $post_id, (bool) $sample ); 

Parameters (3)

0. $link (string)
The page's permalink.
1. $post_id (int)
The ID of the page.
2. $sample (bool)
Is it a sample permalink.

Usage

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

Defined (1)

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

/wp-includes/link-template.php  
  1. return apply_filters( 'page_link', $link, $post->ID, $sample );