get_sample_permalink( int|WP_Post $post, string|null $title = null, string|null $name = null ): array

Compatibility

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

Parameters

$postint|WP_Post

Post ID or post object.

$titlestring|nulloptional

Title to override the post's current title when generating the post name. Default null.Default: null

$namestring|nulloptional

Name to override the post name. Default null.Default: null

Return value

array

Array containing the sample permalink with placeholder for the post name, and the post name.

• $0string

  The permalink with placeholder for the post name.

• $1string

  The post name.

Performance profile

How much work a call to get_sample_permalink() 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

9–149

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

Plugin surface

2 hooks

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

Called by

2

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

What it touches

• querycontent queryget_post()called directly
• hookthird-party callbacksapply_filters()called directly
• optionoption read or writeget_option()one call below get_sample_permalink()

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

What one call costs · 10 distinct outcomes

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

Hooks and filters fired · 3

3 hooks fire while get_sample_permalink() runs, in this order:

1. 1
   apply_filters( editable_slug )filterline 1512 (+47 into the body)

   Filters the editable slug for a post or term.

2. 2
   apply_filters( editable_slug )filterline 1520 (+55 into the body)

   Filters the editable slug for a post or term.

3. 3
   apply_filters( get_sample_permalink )filterline 1542 (+77 into the body)

   Filters the sample permalink.

Uses · 8

• get_post()Retrieves post data given a post ID or post object.
• get_post_type_object()Retrieves a post type object by name.
• sanitize_title()Sanitizes a string into a slug, which can be used in URLs or HTML attributes.
• wp_unique_post_slug()Computes a unique slug for the post, when given the desired slug and some post details.
• get_permalink()Retrieves the full permalink for the current post or post ID.
• get_page_uri()Builds the URI path for a page.
• untrailingslashit()Removes trailing forward slashes and backslashes if they exist.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 2

• WP_REST_Posts_Controller::prepare_item_for_response()Prepares a single post output for response.
• get_sample_permalink_html()Returns the HTML of the sample permalink slug editor.

Source code

View on Trac ↗View on GitHub ↗

1465function get_sample_permalink( $post, $title = null, $name = null ) {1466	$post = get_post( $post );1467 1468	if ( ! $post ) {1469		return array( '', '' );1470	}1471 1472	$ptype = get_post_type_object( $post->post_type );1473 1474	$original_status = $post->post_status;1475	$original_date   = $post->post_date;1476	$original_name   = $post->post_name;1477	$original_filter = $post->filter;1478 1479	// Hack: get_permalink() would return plain permalink for drafts, so we will fake that our post is published.1480	if ( in_array( $post->post_status, array( 'auto-draft', 'draft', 'pending', 'future' ), true ) ) {1481		$post->post_status = 'publish';1482		$post->post_name   = sanitize_title( $post->post_name ? $post->post_name : $post->post_title, $post->ID );1483	}1484 1485	/*1486	 * If the user wants to set a new name -- override the current one.1487	 * Note: if empty name is supplied -- use the title instead, see #6072.1488	 */1489	if ( ! is_null( $name ) ) {1490		$post->post_name = sanitize_title( $name ? $name : $title, $post->ID );1491	}1492 1493	$post->post_name = wp_unique_post_slug( $post->post_name, $post->ID, $post->post_status, $post->post_type, $post->post_parent );1494 1495	$post->filter = 'sample';1496 1497	$permalink = get_permalink( $post, true );1498 1499	// Replace custom post_type token with generic pagename token for ease of use.1500	$permalink = str_replace( "%$post->post_type%", '%pagename%', $permalink );1501 1502	// Handle page hierarchy.1503	if ( $ptype->hierarchical ) {1504		$uri = get_page_uri( $post );1505		if ( $uri ) {1506			$uri = untrailingslashit( $uri );1507			$uri = strrev( stristr( strrev( $uri ), '/' ) );1508			$uri = untrailingslashit( $uri );1509		}1510 1511		/** This filter is documented in wp-admin/edit-tag-form.php */1512		$uri = apply_filters( 'editable_slug', $uri, $post );1513		if ( ! empty( $uri ) ) {1514			$uri .= '/';1515		}1516		$permalink = str_replace( '%pagename%', "{$uri}%pagename%", $permalink );1517	}1518 1519	/** This filter is documented in wp-admin/edit-tag-form.php */1520	$permalink         = array( $permalink, apply_filters( 'editable_slug', $post->post_name, $post ) );1521	$post->post_status = $original_status;1522	$post->post_date   = $original_date;1523	$post->post_name   = $original_name;1524	$post->filter      = $original_filter;1525 1526	/**1527	 * Filters the sample permalink.1528	 *1529	 * @since 4.4.01530	 *1531	 * @param array   $permalink {1532	 *     Array containing the sample permalink with placeholder for the post name, and the post name.1533	 *1534	 *     @type string $0 The permalink with placeholder for the post name.1535	 *     @type string $1 The post name.1536	 * }1537	 * @param int     $post_id Post ID.1538	 * @param string  $title   Post title.1539	 * @param string  $name    Post name (slug).1540	 * @param WP_Post $post    Post object.1541	 */1542	return apply_filters( 'get_sample_permalink', $permalink, $post->ID, $title, $name, $post );1543}

Changelog

Introduced in 2.5.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 7.1.0 tag, from src/wp-admin/includes/post.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.