wp_insert_comment()WP 2.0.0

Вставляет/добавляет комментарий в базу данных.

ВАЖНО! Ожидает экранированные данные! Т.е. если мы передаем данные, которые не были получены из $_POST запроса, то их нужно обработать с помощью wp_slash().

Смотрите также функцию wp_new_comment(), которая очищает данные перед тем как вызывать эту функцию.

Основа для: wp_new_comment()
Хуки из функции

Возвращает

int|false. ID нового комментария или false, если не удалось добавить комментарии.

Использование

wp_insert_comment( $commentdata );
$commentdata

Cодержит массив данных добавляемого комментария. Массив может содержать следующие поля:

  • comment_agent(строка)
    HTTP агент (user agent) автора комментария, в момент отправки комментария.
    По умолчанию: ''

  • comment_approved(число|строка)
    Одобрен коммент или нет.
    По умолчанию: 1

  • comment_author(строка)
    Имя автора комментария.
    По умолчанию: ''

  • comment_author_email(строка)
    email автора комментария.
    По умолчанию: ''

  • comment_author_IP(строка)
    IP автора комментария. Автоматически НЕ определяется.
    По умолчанию: ''

  • comment_author_url(строка)
    URL автора комментария.
    По умолчанию: ''

  • comment_content(строка)
    Текст комментария.
    По умолчанию: ''

  • comment_date(строка)
    Дата и время отправки комментария. В MySQL формате.
    По умолчанию: null (текущее время)

  • comment_date_gmt(строка)
    Дата и время отправки комментария в GMT зоне. В MySQL формате.
    По умолчанию: null (текущее время в GMT)

  • comment_karma(число)
    Карма комментария.
    По умолчанию: 0

  • comment_parent(число)
    ID родительского комментария, которому этот комментарий будет дочерним.
    По умолчанию: 0

  • comment_post_ID(число)
    ID записи к которой относится комментарий.
    По умолчанию: ''

  • comment_type(строка)
    Тип комментария. Обычный комментарий не имеет типа, т.е. равен ''.
    По умолчанию: 'comment'

  • user_id(число)
    ID пользователя который публикует комментарий.
    По умолчанию: 0

  • comment_meta(массив)
    Массив из пар: ключ => значение которые будут добавлены в метаданные комментария.
    По умолчанию: null

Примеры

2

#1 Пример добавления нового комментария

$data = [
	'comment_post_ID'      => 1,
	'comment_author'       => 'admin',
	'comment_author_email' => 'admin@admin.com',
	'comment_author_url'   => 'http://',
	'comment_content'      => 'content here',
	'comment_type'         => 'comment',
	'comment_parent'       => 0,
	'user_id'              => 1,
	'comment_author_IP'    => '127.0.0.1',
	'comment_agent'        => 'Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.9.0.10) Gecko/2009042316 Firefox/3.0.10 (.NET CLR 3.5.30729)',
	'comment_date'         => null, // получим current_time('mysql')
	'comment_approved'     => 1,
];

wp_insert_comment( wp_slash($data) );

Заметки

  • Global. wpdb. $wpdb WordPress database abstraction object.

Список изменений

С версии 2.0.0 Введена.
С версии 4.4.0 Introduced the $comment_meta argument.
С версии 5.5.0 Default value for $comment_type argument changed to comment.

Код wp_insert_comment() WP 6.5.2

function wp_insert_comment( $commentdata ) {
	global $wpdb;

	$data = wp_unslash( $commentdata );

	$comment_author       = ! isset( $data['comment_author'] ) ? '' : $data['comment_author'];
	$comment_author_email = ! isset( $data['comment_author_email'] ) ? '' : $data['comment_author_email'];
	$comment_author_url   = ! isset( $data['comment_author_url'] ) ? '' : $data['comment_author_url'];
	$comment_author_ip    = ! isset( $data['comment_author_IP'] ) ? '' : $data['comment_author_IP'];

	$comment_date     = ! isset( $data['comment_date'] ) ? current_time( 'mysql' ) : $data['comment_date'];
	$comment_date_gmt = ! isset( $data['comment_date_gmt'] ) ? get_gmt_from_date( $comment_date ) : $data['comment_date_gmt'];

	$comment_post_id  = ! isset( $data['comment_post_ID'] ) ? 0 : $data['comment_post_ID'];
	$comment_content  = ! isset( $data['comment_content'] ) ? '' : $data['comment_content'];
	$comment_karma    = ! isset( $data['comment_karma'] ) ? 0 : $data['comment_karma'];
	$comment_approved = ! isset( $data['comment_approved'] ) ? 1 : $data['comment_approved'];
	$comment_agent    = ! isset( $data['comment_agent'] ) ? '' : $data['comment_agent'];
	$comment_type     = empty( $data['comment_type'] ) ? 'comment' : $data['comment_type'];
	$comment_parent   = ! isset( $data['comment_parent'] ) ? 0 : $data['comment_parent'];

	$user_id = ! isset( $data['user_id'] ) ? 0 : $data['user_id'];

	$compacted = array(
		'comment_post_ID'   => $comment_post_id,
		'comment_author_IP' => $comment_author_ip,
	);

	$compacted += compact(
		'comment_author',
		'comment_author_email',
		'comment_author_url',
		'comment_date',
		'comment_date_gmt',
		'comment_content',
		'comment_karma',
		'comment_approved',
		'comment_agent',
		'comment_type',
		'comment_parent',
		'user_id'
	);

	if ( ! $wpdb->insert( $wpdb->comments, $compacted ) ) {
		return false;
	}

	$id = (int) $wpdb->insert_id;

	if ( 1 == $comment_approved ) {
		wp_update_comment_count( $comment_post_id );

		$data = array();
		foreach ( array( 'server', 'gmt', 'blog' ) as $timezone ) {
			$data[] = "lastcommentmodified:$timezone";
		}
		wp_cache_delete_multiple( $data, 'timeinfo' );
	}

	clean_comment_cache( $id );

	$comment = get_comment( $id );

	// If metadata is provided, store it.
	if ( isset( $commentdata['comment_meta'] ) && is_array( $commentdata['comment_meta'] ) ) {
		foreach ( $commentdata['comment_meta'] as $meta_key => $meta_value ) {
			add_comment_meta( $comment->comment_ID, $meta_key, $meta_value, true );
		}
	}

	/**
	 * Fires immediately after a comment is inserted into the database.
	 *
	 * @since 2.8.0
	 *
	 * @param int        $id      The comment ID.
	 * @param WP_Comment $comment Comment object.
	 */
	do_action( 'wp_insert_comment', $id, $comment );

	return $id;
}