edit_post_link( string $text = null, string $before = '', string $after = '', int|WP_Post $post = 0, string $css_class = 'post-edit-link' )

Compatibility

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

Parameters

$textstringoptional

Anchor text. If null, default is 'Edit This'. Default null.Default: null

$beforestringoptional

Display before edit link. Default empty.Default: ''

$afterstringoptional

Display after edit link. Default empty.Default: ''

$postint|WP_Postoptional

Post ID or post object. Default is the global $post.Default: 0

$css_classstringoptional

Add custom class to link. Default 'post-edit-link'.Default: 'post-edit-link'

Performance profile

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

11–47

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

Plugin surface

1 hook

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

Called by

3

3 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

Further down the call graph this can also reach option, 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 · 4 distinct outcomes

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( edit_post_link )filterline 1541 (+28 into the body)

   Filters the post edit link anchor tag.

Uses · 6

• get_post()Retrieves post data given a post ID or post object.
• get_edit_post_link()Retrieves the edit post link for post.
• __()Retrieves the translation of $text.
• esc_attr()Escaping for HTML attributes.
• esc_url()Checks and cleans a URL.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 3

• twenty_twenty_one_entry_meta_footer()Prints HTML with meta information for the categories, tags and comments.
• twentynineteen_entry_footer()Prints HTML with meta information for the categories, tags and comments.
• twentyseventeen_edit_link()Displays an accessibility-friendly link to edit a post or page.

Source code

View on Trac ↗View on GitHub ↗

1513function edit_post_link( $text = null, $before = '', $after = '', $post = 0, $css_class = 'post-edit-link' ) {1514	$post = get_post( $post );1515 1516	if ( ! $post ) {1517		return;1518	}1519 1520	$url = get_edit_post_link( $post->ID );1521 1522	if ( ! $url ) {1523		return;1524	}1525 1526	if ( null === $text ) {1527		$text = __( 'Edit This' );1528	}1529 1530	$link = '<a class="' . esc_attr( $css_class ) . '" href="' . esc_url( $url ) . '">' . $text . '</a>';1531 1532	/**1533	 * Filters the post edit link anchor tag.1534	 *1535	 * @since 2.3.01536	 *1537	 * @param string $link    Anchor tag for the edit link.1538	 * @param int    $post_id Post ID.1539	 * @param string $text    Anchor text.1540	 */1541	echo $before . apply_filters( 'edit_post_link', $link, $post->ID, $text ) . $after;1542}

Changelog

Introduced in 1.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 7.1.0 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.