get_page_link
Filters the permalink for a non-page_on_front page.
Description
Parameters (2)
- 0. $link (string)
- The page's permalink.
- 1. $post_id (int)
- The ID of the page.
Usage
- To run the hook, copy the example below.
- $link = apply_filters( 'get_page_link', $link, $post_id );
- if ( !empty( $link ) ) {
- // everything has led up to this point...
- }
- The following example is for adding a hook callback.
- // define the get_page_link callback
- function filter_get_page_link( $link, $post_id ) {
- // make filter magic happen here...
- return $link;
- };
- // add the filter
- add_filter( 'get_page_link', 'filter_get_page_link', 10, 2 );
- To remove a hook callback, use the example below.
- // remove the filter
- remove_filter( 'get_page_link', 'filter_get_page_link', 10, 2 );
Defined (1)
The filter is defined in the following location(s).
- /wp-includes/link-template.php
- return apply_filters( '_get_page_link', $link, $post->ID );