get_edit_post_link( int|WP_Post $id, string $context = 'display' )

Retrieves the edit post link for post.

Description

Can be used within the WordPress loop or outside of it. Can be used with pages, posts, attachments, and revisions.

Parameters

$id

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

$context

(string) (Optional) How to output the '&' character. Default '&'.

Default value: 'display'

Return

(string|null) The edit post link for the given post. Null if the post type does not exist or does not allow an editing UI.

Source

File: wp-includes/link-template.php 

function get_edit_post_link( $id = 0, $context = 'display' ) {
	$post = get_post( $id );
	if ( ! $post ) {
		return;
	}

	if ( 'revision' === $post->post_type ) {
		$action = '';
	} elseif ( 'display' === $context ) {
		$action = '&action=edit';
	} else {
		$action = '&action=edit';
	}

	$post_type_object = get_post_type_object( $post->post_type );
	if ( ! $post_type_object ) {
		return;
	}

	if ( ! current_user_can( 'edit_post', $post->ID ) ) {
		return;
	}

	if ( $post_type_object->_edit_link ) {
		$link = admin_url( sprintf( $post_type_object->_edit_link . $action, $post->ID ) );
	} else {
		$link = '';
	}

	/**
	 * Filters the post edit link.
	 *
	 * @since 2.3.0
	 *
	 * @param string $link    The edit link.
	 * @param int    $post_id Post ID.
	 * @param string $context The link context. If set to 'display' then ampersands
	 *                        are encoded.
	 */
	return apply_filters( 'get_edit_post_link', $link, $post->ID, $context );
}

Uses

Uses Description
wp-includes/capabilities.php: current_user_can()

Returns whether the current user has the specified capability.
wp-includes/link-template.php: admin_url()

Retrieves the URL to the admin area for the current site.
wp-includes/link-template.php: get_edit_post_link

Filters the post edit link.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.
wp-includes/post.php: get_post()

Retrieves post data given a post ID or post object.
wp-includes/post.php: get_post_type_object()

Retrieves a post type object by name.

Used By

Used By Description
wp-admin/includes/template.php: do_block_editor_incompatible_meta_box()

Function that renders a “fake” meta box with an information message, shown on the block editor, when an incompatible meta box is found.
wp-admin/includes/class-wp-posts-list-table.php: WP_Posts_List_Table::handle_row_actions()

Generates and displays row action links.
wp-admin/includes/class-wp-posts-list-table.php: WP_Posts_List_Table::column_title()

Handles the title column output.
wp-admin/includes/class-wp-media-list-table.php: WP_Media_List_Table::column_parent()

Handles the parent column output.
wp-admin/includes/class-wp-media-list-table.php: WP_Media_List_Table::column_title()

Handles the title column output.
wp-admin/includes/dashboard.php: wp_welcome_panel()

Displays a welcome panel to introduce users to WordPress.
wp-admin/includes/dashboard.php: wp_dashboard_recent_posts()

Generates Publishing Soon and Recently Published sections.
wp-admin/includes/dashboard.php: wp_dashboard_recent_drafts()

Show recent drafts of the user on the dashboard.
wp-admin/includes/media.php: attachment_submitbox_metadata()

Displays non-editable attachment metadata in the publish meta box.
wp-admin/includes/post.php: _admin_notice_post_locked()

Outputs the HTML for the notice to say that someone else is editing or has taken over editing of this post.
wp-admin/includes/meta-boxes.php: post_submit_meta_box()

Displays post submit form fields.
wp-admin/includes/class-wp-media-list-table.php: WP_Media_List_Table::_get_row_actions()
wp-admin/includes/class-wp-comments-list-table.php: WP_Comments_List_Table::column_response()
wp-admin/includes/post.php: redirect_post()

Redirect to previous page.
wp-includes/link-template.php: edit_post_link()

Displays the edit post link for post.
wp-includes/admin-bar.php: wp_admin_bar_edit_menu()

Provide an edit link for posts and terms.
wp-includes/post-template.php: wp_post_revision_title()

Retrieve formatted date timestamp of a revision (linked to that revisions’s page).
wp-includes/post-template.php: wp_post_revision_title_expanded()

Retrieve formatted date timestamp of a revision (linked to that revisions’s page).
wp-includes/media.php: wp_prepare_attachment_for_js()

Prepares an attachment post object for JS, where it is expected to be JSON-encoded and fit into an Attachment model.

Changelog

Version Description
2.3.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_edit_post_link