wppaste
WordPress

apply_filters( 'pre_get_shortlink', false|string $return, int $id, string $context, bool $allow_slugs )

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

Description

Returning a value other than false from the filter will short-circuit the shortlink generation process, returning that value instead.

Compatibility

WordPress
since 3.0.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

$returnfalse|string
Short-circuit return value. Either false or a URL string.
$idint
Post ID, or 0 for the current post.
$contextstring
The context for the link. One of 'post' or 'query',
$allow_slugsbool
Whether to allow post slugs in the shortlink.

Where this hook fires · 1

  • wp-includes/link-template.php:4158wp_get_shortlink()

Source code

	 *	 * @param false|string $return      Short-circuit return value. Either false or a URL string.	 * @param int          $id          Post ID, or 0 for the current post.	 * @param string       $context     The context for the link. One of 'post' or 'query',	 * @param bool         $allow_slugs Whether to allow post slugs in the shortlink.	 */	$shortlink = apply_filters( 'pre_get_shortlink', false, $id, $context, $allow_slugs ); 	if ( false !== $shortlink ) {		return $shortlink;	} 	$post_id = 0;

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.8.8 tag, 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.