the_shortlink( string $text = '', string $title = '', string $before = '', string $after = '' )
Displays the shortlink for a post.
Description
Must be called from inside "The Loop"
Call like the_shortlink( __( ‘Shortlinkage FTW’ ) )
Parameters
- $text
-
(string) (Optional) The link text or HTML to be displayed. Defaults to 'This is the short link.'
Default value: ''
- $title
-
(string) (Optional) The tooltip for the link. Must be sanitized. Defaults to the sanitized post title.
Default value: ''
- $before
-
(string) (Optional) HTML to display before the link.
Default value: ''
- $after
-
(string) (Optional) HTML to display after the link.
Default value: ''
Source
File: wp-includes/link-template.php
function the_shortlink( $text = '', $title = '', $before = '', $after = '' ) {
$post = get_post();
if ( empty( $text ) )
$text = __('This is the short link.');
if ( empty( $title ) )
$title = the_title_attribute( array( 'echo' => false ) );
$shortlink = wp_get_shortlink( $post->ID );
if ( !empty( $shortlink ) ) {
$link = '<a rel="shortlink" href="' . esc_url( $shortlink ) . '" title="' . $title . '">' . $text . '</a>';
/**
* Filters the short link anchor tag for a post.
*
* @since WP-3.0.0
*
* @param string $link Shortlink anchor tag.
* @param string $shortlink Shortlink URL.
* @param string $text Shortlink's text.
* @param string $title Shortlink's title attribute.
*/
$link = apply_filters( 'the_shortlink', $link, $shortlink, $text, $title );
echo $before, $link, $after;
}
}
Changelog
Version | Description |
---|---|
WP-3.0.0 | Introduced. |