wp_spam_comment() │ WP 2.9.0

Moves the specified comment to Spam (marks the comment as spam).

See also the similar function: wp_trash_comment().

Uses: wp_set_comment_status()
Hooks from the function

Returns

true|false. true if the comment was successfully moved to spam and false on failure.

Usage

wp_spam_comment( $comment_id );
$comment_id(integer/WP_Comment) (required)
ID/object of the comment to be moved to spam.

Examples

1

#1 Send comment with ID 3 to spam 

$comm_id = 3;
$spammed = wp_spam_comment( $comm_id );
if( $spammed ){
	echo 'Comment sent to spam.'
}

Changelog

Since 2.9.0 Introduced.

wp_spam_comment() code WP 6.9

wp-includes/comment.php 
function wp_spam_comment( $comment_id ) {
	$comment = get_comment( $comment_id );
	if ( ! $comment ) {
		return false;
	}

	/**
	 * Fires immediately before a comment is marked as Spam.
	 *
	 * @since 2.9.0
	 * @since 4.9.0 Added the `$comment` parameter.
	 *
	 * @param int        $comment_id The comment ID.
	 * @param WP_Comment $comment    The comment to be marked as spam.
	 */
	do_action( 'spam_comment', $comment->comment_ID, $comment );

	if ( wp_set_comment_status( $comment, 'spam' ) ) {
		delete_comment_meta( $comment->comment_ID, '_wp_trash_meta_status' );
		delete_comment_meta( $comment->comment_ID, '_wp_trash_meta_time' );
		add_comment_meta( $comment->comment_ID, '_wp_trash_meta_status', $comment->comment_approved );
		add_comment_meta( $comment->comment_ID, '_wp_trash_meta_time', time() );

		/**
		 * Fires immediately after a comment is marked as Spam.
		 *
		 * @since 2.9.0
		 * @since 4.9.0 Added the `$comment` parameter.
		 *
		 * @param int        $comment_id The comment ID.
		 * @param WP_Comment $comment    The comment marked as spam.
		 */
		do_action( 'spammed_comment', $comment->comment_ID, $comment );

		return true;
	}

	return false;
}

Comments

Comments