WordPress.org

Languages: English • 日本語 (Add your language)

Description

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.

This tag can not be used outside of The Loop.

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

Usage

 <?php the_shortlink( $text, $title, $before, $after ); ?> 

Parameters

$text

(string) (optional) Link text to display.

Default: 'This is the short link.'

$title

(string) (optional) Tool-tip text displayed with the link.

Default: post title

$before

(string) (optional) Text or HTML prefix added to the link.

Default: None

$after

(string) (optional) Text or HTML suffix added to the link.

Default: None

Examples

Default Usage

Displays link with "This is the short link." as the text.

 <?php the_shortlink(); ?> 

Custom Text

Displays link with the specified text.

 <?php the_shortlink(__('Shortlinkage FTW')); ?> 

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>'); ?> 

Source File

the_shortlink() is located in wp-includes/link-template.php.

Change Log

• Since: 3.0.0

Related

• Function: body_class()
• Function: next_image_link()
• Function: next_post_link()
• Function: next_posts_link()
• Function: post_class()
• Function: post_password_required()
• Function: posts_nav_link()
• Function: previous_image_link()
• Function: previous_post_link()
• Function: previous_posts_link()
• Function: single_post_title()
• Function: sticky_class()
• Function: the_category()
• Function: the_category_rss()
• Function: the_content()
• Function: the_content_rss()
• Function: the_excerpt()
• Function: the_excerpt_rss()
• Function: the_ID()
• Function: the_meta()
• Function: the_shortlink()
• Function: the_tags()
• Function: the_title()
• Function: the_title_attribute()
• Function: the_title_rss()
• Function: wp_link_pages()