get_comment_to_edit() WordPress Function
The get_comment_to_edit() function allows a user to edit a comment on a WordPress post. This function can be used by a WordPress administrator to edit a comment made by a WordPress user.
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; }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
2.0.0 | Introduced. |