the_shortlink() – Function | Developer.WordPress.org

Displays the shortlink for a post.

Description

Must be called from inside "The Loop"

Call like the_shortlink( __( ‘Shortlinkage FTW’ ) )

Parameters

$textstringoptional: Optional The link text or HTML to be displayed. Defaults to ‘This is the short link.’
Default:''
$titlestringoptional: Optional The tooltip for the link. Must be sanitized. Defaults to the sanitized post title.
Default:''
$beforestringoptional: Optional HTML to display before the link.
Default:''
$afterstringoptional: Optional HTML to display after the link.
Default:''

Used on single post permalink pages, this template tag displays a “URL shortening” link for the current post. By default, this will mean the URL has a format of /?p=1234, and will only appear if pretty permalinks are enabled.

However, this feature is limited by design and intended to be leveraged by plugins that may offer links in a different format, a custom format, or even a format provided by a third-party URL shortening service. Refer to get_permalink() if you want to return the permalink to a post for use in PHP.

Note: This function outputs the complete shortlink for the post, to return the shortlink use wp_get_shortlink().

Source

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 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;
	}
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘the_shortlink’, string $link, string $shortlink, string $text, string $title ): Filters the short link anchor tag for a post.

Uses	Description
wp_get_shortlink()`wp-includes/link-template.php`	Returns a shortlink for a post, page, attachment, or site.
the_title_attribute()`wp-includes/post-template.php`	Sanitizes the current title when retrieving or displaying.
__()`wp-includes/l10n.php`	Retrieves the translation of $text.
esc_url()`wp-includes/formatting.php`	Checks and cleans a URL.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.
get_post()`wp-includes/post.php`	Retrieves post data given a post ID or post object.

Show 4 more Show less

Changelog

Version	Description
3.0.0	Introduced.

User Contributed Notes

Skip to note 4 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
Custom Text
Displays link with the specified text.
```
<?php the_shortlink( __( 'Shortlinkage FTW', 'textdomain' ) ); ?> 
```
Output:
Shortlinkage FTW
Log in to add feedback
Skip to note 5 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note
Default Usage
Displays link with “This is the short link.” as the text.
```
 <?php the_shortlink(); ?> 
```
Output:

This is the short link.
Log in to add feedback
Skip to note 6 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note
Conditional HTML
Displays link with prefix and suffix HTML that will appear only when the shortlink URL is available.
```
<?php the_shortlink( 'short link', null, '<ul><li>', '</li></ul>' ); ?> 

<a href="#" rel="nofollow">short link</a>
```
Log in to add feedback

the_shortlink( string $text = ”, string $title = ”, string $before = ”, string $after = ” )

In this article