wp_get_shortlink( int $id = 0, string $context = 'post', bool $allow_slugs = true ): string

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$idintoptional

A post or site ID. Default is 0, which means the current post or site.Default: 0

$contextstringoptional

Whether the ID is a 'site' ID, 'post' ID, or 'media' ID. If 'post', the post_type of the post is consulted. If 'query', the current query is consulted to determine the ID and context. Default 'post'.Default: 'post'

$allow_slugsbooloptional

Whether to allow post slugs in the shortlink. It is up to the plugin how and whether to honor this. Default true.Default: true

Return value

string

A shortlink or an empty string if no shortlink exists for the requested resource or if shortlinks are not enabled.

Performance profile

How much work a call to wp_get_shortlink() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

14–68

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 82.

Plugin surface

2 hooks

Third-party callbacks on 'pre_get_shortlink', 'get_shortlink' run inside this call, and their cost is not bounded by anything here.

Called by

4

4 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• querycontent queryget_post()called directly
• optionoption read or writeget_option()called directly
• cacheobject cachewp_cache_get()one call below wp_get_shortlink()
• serializeserialisationmaybe_unserialize()one call below wp_get_shortlink()

Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 36 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_get_shortlink() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while wp_get_shortlink() runs, in this order:

1. 1
   apply_filters( pre_get_shortlink )filterline 4159 (+14 into the body)

   Filters whether to preempt generating a shortlink for the given post.

2. 2
   apply_filters( get_shortlink )filterline 4201 (+56 into the body)

   Filters the shortlink for a post.

Uses · 7

• apply_filters()Calls the callback functions that have been added to a filter hook.
• is_singular()Determines whether the query is for an existing single post of any post type (post, attachment, page, custom post types).
• get_queried_object_id()Retrieves the ID of the currently queried object.
• get_post()Retrieves post data given a post ID or post object.
• get_post_type_object()Retrieves a post type object by name.
• get_option()Retrieves an option value based on an option name.
• home_url()Retrieves the URL for the current site where the front end is accessible.

Used by · 4

• the_shortlink()Displays the shortlink for a post.
• wp_admin_bar_shortlink_menu()Provides a shortlink.
• wp_shortlink_header()Sends a Link: rel=shortlink header if a shortlink is defined for the current page.
• wp_shortlink_wp_head()Injects rel=shortlink into the head if a shortlink is defined for the current page.

Source code

View on Trac ↗View on GitHub ↗

4145function wp_get_shortlink( $id = 0, $context = 'post', $allow_slugs = true ) {4146	/**4147	 * Filters whether to preempt generating a shortlink for the given post.4148	 *4149	 * Returning a value other than false from the filter will short-circuit4150	 * the shortlink generation process, returning that value instead.4151	 *4152	 * @since 3.0.04153	 *4154	 * @param false|string $return      Short-circuit return value. Either false or a URL string.4155	 * @param int          $id          Post ID, or 0 for the current post.4156	 * @param string       $context     The context for the link. One of 'post' or 'query',4157	 * @param bool         $allow_slugs Whether to allow post slugs in the shortlink.4158	 */4159	$shortlink = apply_filters( 'pre_get_shortlink', false, $id, $context, $allow_slugs );4160 4161	if ( false !== $shortlink ) {4162		return $shortlink;4163	}4164 4165	$post_id = 0;4166	if ( 'query' === $context && is_singular() ) {4167		$post_id = get_queried_object_id();4168		$post    = get_post( $post_id );4169	} elseif ( 'post' === $context ) {4170		$post = get_post( $id );4171		if ( ! empty( $post->ID ) ) {4172			$post_id = $post->ID;4173		}4174	}4175 4176	$shortlink = '';4177 4178	// Return `?p=` link for all public post types.4179	if ( ! empty( $post_id ) ) {4180		$post_type = get_post_type_object( $post->post_type );4181 4182		if ( 'page' === $post->post_type4183			&& 'page' === get_option( 'show_on_front' ) && (int) get_option( 'page_on_front' ) === $post->ID4184		) {4185			$shortlink = home_url( '/' );4186		} elseif ( $post_type && $post_type->public ) {4187			$shortlink = home_url( '?p=' . $post_id );4188		}4189	}4190 4191	/**4192	 * Filters the shortlink for a post.4193	 *4194	 * @since 3.0.04195	 *4196	 * @param string $shortlink   Shortlink URL.4197	 * @param int    $id          Post ID, or 0 for the current post.4198	 * @param string $context     The context for the link. One of 'post' or 'query',4199	 * @param bool   $allow_slugs Whether to allow post slugs in the shortlink. Not used by default.4200	 */4201	return apply_filters( 'get_shortlink', $shortlink, $id, $context, $allow_slugs );4202}

Changelog

Introduced in 3.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/link-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.