W3cubDocs

/WordPress

get_comment_to_edit( int $id )

Returns a WP_Comment object based on comment ID.

Parameters

$id

(int) (Required) ID of comment to retrieve.

Return

(WP_Comment|false) Comment if found. False on failure.

Source

File: wp-admin/includes/comment.php 

function get_comment_to_edit( $id ) {
	$comment = get_comment( $id );
	if ( ! $comment ) {
		return false;
	}

	$comment->comment_ID      = (int) $comment->comment_ID;
	$comment->comment_post_ID = (int) $comment->comment_post_ID;

	$comment->comment_content = format_to_edit( $comment->comment_content );
	/**
	 * Filters the comment content before editing.
	 *
	 * @since 2.0.0
	 *
	 * @param string $comment_content Comment content.
	 */
	$comment->comment_content = apply_filters( 'comment_edit_pre', $comment->comment_content );

	$comment->comment_author       = format_to_edit( $comment->comment_author );
	$comment->comment_author_email = format_to_edit( $comment->comment_author_email );
	$comment->comment_author_url   = format_to_edit( $comment->comment_author_url );
	$comment->comment_author_url   = esc_url( $comment->comment_author_url );

	return $comment;
}

Uses

Uses Description
wp-admin/includes/comment.php: comment_edit_pre

Filters the comment content before editing.
wp-includes/formatting.php: esc_url()

Checks and cleans a URL.
wp-includes/formatting.php: format_to_edit()

Acts on text which is about to be edited.
wp-includes/plugin.php: apply_filters()

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

Retrieves comment data given a comment ID or comment object.

Changelog

Version Description
2.0.0 Introduced.

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