Codex

Function Reference/the shortlink

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

Contents

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 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 "The is the short link." as the text.

The is the short link.

 <?php the_shortlink(); ?> 

Custom Text

Displays link with the specified text.

Shortlinkage FTW

 <?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

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

See also index of Function Reference and index of Template Tags.
Retrieved from "http://codex.wordpress.org/Function_Reference/the_shortlink"

Codex Resources