edit_post_link

Advertisement

Summery Summery

Displays the edit post link for post.

Syntax Syntax

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

Parameters Parameters

$text

(Optional) Anchor text. If null, default is 'Edit This'.

Default value: null

$before

(Optional) Display before edit link.

Default value: ''

$after

(Optional) Display after edit link.

Default value: ''

$id

(Optional) Post ID or post object. Default is the global $post.

$class

(Optional) Add custom class to link. Default 'post-edit-link'.

Default value: 'post-edit-link'

Source Source

File: wp-includes/link-template.php

function edit_post_link( $text = null, $before = '', $after = '', $id = 0, $class = 'post-edit-link' ) {
	$post = get_post( $id );
	if ( ! $post ) {
		return;
	}

	$url = get_edit_post_link( $post->ID );
	if ( ! $url ) {
		return;
	}

	if ( null === $text ) {
		$text = __( 'Edit This' );
	}

	$link = '<a class="' . esc_attr( $class ) . '" href="' . esc_url( $url ) . '">' . $text . '</a>';

	/**
	 * Filters the post edit link anchor tag.
	 *
	 * @since 2.3.0
	 *
	 * @param string $link    Anchor tag for the edit link.
	 * @param int    $post_id Post ID.
	 * @param string $text    Anchor text.
	 */
	echo $before . apply_filters( 'edit_post_link', $link, $post->ID, $text ) . $after;
}

Advertisement

Changelog Changelog

Changelog
Version Description
4.4.0 The $class argument was added.
1.0.0 Introduced.

Advertisement

Leave a Reply