On this page
wp_untrash_comment( int|WP_Comment $comment_id ): bool
Removes a comment from the Trash
Parameters
$comment_idint|WP_Comment Required-
Comment ID or WP_Comment object.
Return
bool True on success, false on failure.
Source
File: wp-includes/comment.php. View all references
function wp_untrash_comment( $comment_id ) {
$comment = get_comment( $comment_id );
if ( ! $comment ) {
return false;
}
/**
* Fires immediately before a comment is restored from the Trash.
*
* @since 2.9.0
* @since 4.9.0 Added the `$comment` parameter.
*
* @param string $comment_id The comment ID as a numeric string.
* @param WP_Comment $comment The comment to be untrashed.
*/
do_action( 'untrash_comment', $comment->comment_ID, $comment );
$status = (string) get_comment_meta( $comment->comment_ID, '_wp_trash_meta_status', true );
if ( empty( $status ) ) {
$status = '0';
}
if ( wp_set_comment_status( $comment, $status ) ) {
delete_comment_meta( $comment->comment_ID, '_wp_trash_meta_time' );
delete_comment_meta( $comment->comment_ID, '_wp_trash_meta_status' );
/**
* Fires immediately after a comment is restored from the Trash.
*
* @since 2.9.0
* @since 4.9.0 Added the `$comment` parameter.
*
* @param string $comment_id The comment ID as a numeric string.
* @param WP_Comment $comment The untrashed comment.
*/
do_action( 'untrashed_comment', $comment->comment_ID, $comment );
return true;
}
return false;
}
Hooks
- do_action( 'untrashed_comment',
string $comment_id ,WP_Comment $comment ) -
Fires immediately after a comment is restored from the Trash.
- do_action( 'untrash_comment',
string $comment_id ,WP_Comment $comment ) -
Fires immediately before a comment is restored from the Trash.
Related
Uses
| Uses | Description |
|---|---|
| get_comment_meta() wp-includes/comment.php | Retrieves comment meta field for a comment. |
| wp_set_comment_status() wp-includes/comment.php | Sets the status of a comment. |
| delete_comment_meta() wp-includes/comment.php | Removes metadata matching criteria from a comment. |
| do_action() wp-includes/plugin.php | Calls the callback functions that have been added to an action hook. |
| get_comment() wp-includes/comment.php | Retrieves comment data given a comment ID or comment object. |
Used By
| Used By | Description |
|---|---|
| WP_REST_Comments_Controller::handle_status_param() wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php | Sets the comment_status of a given comment object when creating or updating a comment. |
| wp_ajax_delete_comment() wp-admin/includes/ajax-actions.php | Ajax handler for deleting a comment. |
Changelog
| Version | Description |
|---|---|
| 2.9.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_untrash_comment