Комментарии в WordPress

Комментарии это отдельная сущность в структуре данных WordPress. Связывают комментарии с записями (постами, таблица wp_posts) и пользователями (таблица wp_users).

Структура таблиц комментариев в БД

В базе данных WordPress за комментарии отвечают две таблицы: wp_comments и wp_commentmeta. Разберем каждую.

wp_comments

Содержит основные данные комментария.

// $com - это объект обрабатываемого комментария
wp_update_comment( [
	'comment_ID'   => $com->comment_ID,
	'comment_type' => "archive-$com->comment_type", // archive-question_comment
] );

wp_commentmeta

Содержит дополнительные данные комментария. Из коробки в эту таблицу ничего не записывается, она нужна для расширения функционала комментирования, чтобы добавить комментариям дополнительные данные.

Вывод комментариев в теме

Для вывода комментариев на странице нужно использовать функцию comments_template() в том месте, где нам нужно показать список комментариев. Эта функция сделает запрос и соберет комментарии для страницы.

Также в тему нужно добавить файл comments.php. В нём нужно описать вывод комментариев:

• Нужно проверить есть ли комментарии на странице. Делается это с помощью переменной $comemnts, которая устанавливается в comments_template() - $comments = & $wp_query->comments и доступна в этом файле. Также проверить наличие комментариев на странице можно функцией have_comments(). Далее если:
  • комментарии есть, нужно использовать функцию wp_list_comments() чтобы вывести список комментариев.
  • комментариев нет, нужно вывести сообщение что их нет.
• Нужно вывести форму комментирования. См. comment_form().

Пример файла comments.php из темы Twenty Twenty:

<?php
/**
 * The template file for displaying the comments and comment form for the
 * Twenty Twenty theme.
 *
 * @package WordPress
 * @subpackage Twenty_Twenty
 * @since Twenty Twenty 1.0
 */

/*
 * If the current post is protected by a password and
 * the visitor has not yet entered the password we will
 * return early without loading the comments.
*/
if ( post_password_required() ) {
	return;
}

if ( $comments ) {
	?>

	<div class="comments" id="comments">

		<?php
		$comments_number = absint( get_comments_number() );
		?>

		<div class="comments-header section-inner small max-percentage">

			<h2 class="comment-reply-title">
				<?php
				if ( ! have_comments() ) {
					_e( 'Leave a comment', 'twentytwenty' );
				}
				elseif ( 1 === $comments_number ) {
					/* translators: %s: Post title. */
					printf( _x( 'One reply on “%s”', 'comments title', 'twentytwenty' ), get_the_title() );
				}
				else {
					printf(
					/* translators: 1: Number of comments, 2: Post title. */
						_nx(
							'%1$s reply on “%2$s”',
							'%1$s replies on “%2$s”',
							$comments_number,
							'comments title',
							'twentytwenty'
						),
						number_format_i18n( $comments_number ),
						get_the_title()
					);
				}

				?>
			</h2><!-- .comments-title -->

		</div><!-- .comments-header -->

		<div class="comments-inner section-inner thin max-percentage">

			<?php
			wp_list_comments(
				array(
					'walker'      => new TwentyTwenty_Walker_Comment(),
					'avatar_size' => 120,
					'style'       => 'div',
				)
			);

			$comment_pagination = paginate_comments_links(
				array(
					'echo'      => false,
					'end_size'  => 0,
					'mid_size'  => 0,
					'next_text' => __( 'Newer Comments', 'twentytwenty' ) . ' <span aria-hidden="true">→</span>',
					'prev_text' => '<span aria-hidden="true">←</span> ' . __( 'Older Comments', 'twentytwenty' ),
				)
			);

			if ( $comment_pagination ) {
				$pagination_classes = '';

				// If we're only showing the "Next" link, add a class indicating so.
				if ( false === strpos( $comment_pagination, 'prev page-numbers' ) ) {
					$pagination_classes = ' only-next';
				}
				?>

				<nav class="comments-pagination pagination<?php echo $pagination_classes; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- static output ?>" aria-label="<?php esc_attr_e( 'Comments', 'twentytwenty' ); ?>">
					<?php echo wp_kses_post( $comment_pagination ); ?>
				</nav>

				<?php
			}
			?>

		</div><!-- .comments-inner -->

	</div><!-- comments -->

	<?php
}

if ( comments_open() || pings_open() ) {

	if ( $comments ) {
		echo '<hr class="styled-separator is-style-wide" aria-hidden="true" />';
	}

	comment_form(
		array(
			'class_form'         => 'section-inner thin max-percentage',
			'title_reply_before' => '<h2 id="reply-title" class="comment-reply-title">',
			'title_reply_after'  => '</h2>',
		)
	);

}
elseif ( is_single() ) {

	if ( $comments ) {
		echo '<hr class="styled-separator is-style-wide" aria-hidden="true" />';
	}

	?>

	<div class="comment-respond" id="respond">

		<p class="comments-closed"><?php _e( 'Comments are closed.', 'twentytwenty' ); ?></p>

	</div><!-- #respond -->

	<?php
}

Установка куков комментирования для неавторизованных пользователей

Когда неавторизованный пользователь оставляет комментарий, WP устанавливает куки в которых сохраняются введенные данные. Какие куки сохраняются:

'comment_author_' . COOKIEHASH
'comment_author_email_' . COOKIEHASH
'comment_author_url_' . COOKIEHASH

// где COOKIEHASH = md5( get_site_option( 'siteurl' ) )

Сохраняет эти куки функция wp_set_comment_cookies().

Она по умолчанию повешена на хук set_comment_cookies в файле /wp-includes/default-filters.php:

add_action( 'set_comment_cookies', 'wp_set_comment_cookies', 10, 3 );

Этот хук срабатывает когда комментарий публикуется через форму комментирвоания comment_form(). Т.е. когда отправляется POST запрос в файл /wp-comments-post.php:

/**
 * Perform other actions when comment cookies are set.
 *
 * @since 3.4.0
 * @since 4.9.6 The `$cookies_consent` parameter was added.
 *
 * @param WP_Comment $comment         Comment object.
 * @param WP_User    $user            Comment author's user object. The user may not exist.
 * @param bool       $cookies_consent Comment author's consent to store cookies.
 */
do_action( 'set_comment_cookies', $comment, $user, $cookies_consent );

Используйте wp_get_current_commenter(), чтобы получить данные этих cookies.

Функции комментариев

Это список часто используемых функций. Полный список смотрите здесь.