get_sample_permalink_html( int|WP_Post $post, string|null $new_title = null, string|null $new_slug = null ): string

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.

$new_titlestring|nulloptional

New title. Default null.Default: null

$new_slugstring|nulloptional

New slug. Default null.Default: null

Return value

string

The HTML of the sample permalink slug editor.

Performance profile

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

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

Plugin surface

1 hook

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

Called by

1

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

What it touches

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

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 · 37 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while get_sample_permalink_html() runs, in this order:

1. 1
   apply_filters( get_sample_permalink_html )filterline 1627 (+72 into the body)

   Filters the sample permalink HTML markup.

Uses · 13

• get_post()Retrieves post data given a post ID or post object.
• get_sample_permalink()Returns a sample permalink based on the post name.
• current_user_can()Returns whether the current user has the specified capability.
• get_preview_post_link()Retrieves the URL used for the post preview.
• get_permalink()Retrieves the full permalink for the current post or post ID.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• __()Retrieves the translation of $text.
• esc_url()Checks and cleans a URL.
• esc_html()Escaping for HTML blocks.
• get_option()Retrieves an option value based on an option name.
• mb_strlen()Compat function to mimic mb_strlen().
• mb_substr()Compat function to mimic mb_substr().

Used by · 1

• wp_ajax_sample_permalink()Handles retrieving a sample permalink via AJAX.

Source code

View on Trac ↗View on GitHub ↗

1555function get_sample_permalink_html( $post, $new_title = null, $new_slug = null ) {1556	$post = get_post( $post );1557 1558	if ( ! $post ) {1559		return '';1560	}1561 1562	list($permalink, $post_name) = get_sample_permalink( $post->ID, $new_title, $new_slug );1563 1564	$view_link      = false;1565	$preview_target = '';1566 1567	if ( current_user_can( 'read_post', $post->ID ) ) {1568		if ( 'draft' === $post->post_status || empty( $post->post_name ) ) {1569			$view_link      = get_preview_post_link( $post );1570			$preview_target = " target='wp-preview-{$post->ID}'";1571		} else {1572			if ( 'publish' === $post->post_status || 'attachment' === $post->post_type ) {1573				$view_link = get_permalink( $post );1574			} else {1575				// Allow non-published (private, future) to be viewed at a pretty permalink, in case $post->post_name is set.1576				$view_link = str_replace( array( '%pagename%', '%postname%' ), $post->post_name, $permalink );1577			}1578		}1579	}1580 1581	// Permalinks without a post/page name placeholder don't have anything to edit.1582	if ( ! str_contains( $permalink, '%postname%' ) && ! str_contains( $permalink, '%pagename%' ) ) {1583		$return = '<strong>' . __( 'Permalink:' ) . "</strong>\n";1584 1585		if ( false !== $view_link ) {1586			$display_link = urldecode( $view_link );1587			$return      .= '<a id="sample-permalink" href="' . esc_url( $view_link ) . '"' . $preview_target . '>' . esc_html( $display_link ) . "</a>\n";1588		} else {1589			$return .= '<span id="sample-permalink">' . $permalink . "</span>\n";1590		}1591 1592		// Encourage a pretty permalink setting.1593		if ( ! get_option( 'permalink_structure' ) && current_user_can( 'manage_options' )1594			&& ! ( 'page' === get_option( 'show_on_front' ) && (int) get_option( 'page_on_front' ) === $post->ID )1595		) {1596			$return .= '<span id="change-permalinks"><a href="options-permalink.php" class="button button-small">' . __( 'Change Permalink Structure' ) . "</a></span>\n";1597		}1598	} else {1599		if ( mb_strlen( $post_name ) > 34 ) {1600			$post_name_abridged = mb_substr( $post_name, 0, 16 ) . '&hellip;' . mb_substr( $post_name, -16 );1601		} else {1602			$post_name_abridged = $post_name;1603		}1604 1605		$post_name_html = '<span id="editable-post-name">' . esc_html( $post_name_abridged ) . '</span>';1606		$display_link   = str_replace( array( '%pagename%', '%postname%' ), $post_name_html, esc_html( urldecode( $permalink ) ) );1607 1608		$return  = '<strong>' . __( 'Permalink:' ) . "</strong>\n";1609		$return .= '<span id="sample-permalink"><a href="' . esc_url( $view_link ) . '"' . $preview_target . '>' . $display_link . "</a></span>\n";1610		$return .= '&lrm;'; // Fix bi-directional text display defect in RTL languages.1611		$return .= '<span id="edit-slug-buttons"><button type="button" class="edit-slug button button-small hide-if-no-js" aria-label="' . __( 'Edit permalink' ) . '">' . __( 'Edit' ) . "</button></span>\n";1612		$return .= '<span id="editable-post-name-full">' . esc_html( $post_name ) . "</span>\n";1613	}1614 1615	/**1616	 * Filters the sample permalink HTML markup.1617	 *1618	 * @since 2.9.01619	 * @since 4.4.0 Added `$post` parameter.1620	 *1621	 * @param string      $return    Sample permalink HTML markup.1622	 * @param int         $post_id   Post ID.1623	 * @param string|null $new_title New sample permalink title.1624	 * @param string|null $new_slug  New sample permalink slug.1625	 * @param WP_Post     $post      Post object.1626	 */1627	$return = apply_filters( 'get_sample_permalink_html', $return, $post->ID, $new_title, $new_slug, $post );1628 1629	return $return;1630}

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.0.4 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.