WordPress как на ладони
wordpress jino

get_comments() WP 2.7.0

Получает комментарии по указанным параметрам, в виде массива данных.

Работает на основе: WP_Comment_Query()

Хуков нет.

Возвращает

Массив/число. Массив объектов комментариев:

Array (
	[0] => stdClass Object
		(
			[comment_ID] => 7999
			[comment_post_ID] => 4896
			[comment_author] => Kama
			[comment_author_email] => mail@bk.ru
			[comment_author_url] => 
			[comment_author_IP] => 65.229.196.81
			[comment_date] => 2014-09-08 13:16:09
			[comment_date_gmt] => 2014-09-08 09:16:09
			[comment_content] => текст комментария
			[comment_karma] => 0
			[comment_approved] => 1
			[comment_agent] => 
			[comment_type] => 
			[comment_parent] => 7989
			[user_id] => 1
			[comment_subscribe] => N
		)

	[1] => stdClass Object
		(
			Аналогичные данные, как в объекте 0
		)
)

Или число, когда указано получить кол. комментариев.

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

$comments = get_comments( $args );
foreach( $comments as $comment ){
	// вывод
}

Шаблон использования

$args = array(
	'author_email'        => '',
	'author__in'          => '',
	'author__not_in'      => '',
	'include_unapproved'  => '',
	'fields'              => '',
	'comment__in'         => '',
	'comment__not_in'     => '',
	'karma'               => '',
	'number'              => '',
	'offset'              => '',
	'no_found_rows'       => true,
	'orderby'             => '',
	'order'               => 'DESC',
	'parent'              => '',
	'post_author__in'     => '',
	'post_author__not_in' => '',
	'post_id'             => 0,
	'post__in'            => '',
	'post__not_in'        => '',
	'post_author'         => '',
	'post_name'           => '',
	'post_parent'         => '',
	'post_status'         => '',
	'post_type'           => '',
	'status'              => 'all',
	'type'                => '',
	'type__in'            => '',
	'type__not_in'        => '',
	'user_id'             => '',
	'search'              => '',
	'count'               => false,
	'meta_key'            => '',
	'meta_value'          => '',
	'meta_query'          => '',
	'date_query'          => null, // See WP_Date_Query
	'hierarchical'        => false,
	'update_comment_meta_cache'  => true,
	'update_comment_post_cache'  => false,
);

if( $comments = get_comments( $args ) ){
	foreach( $comments as $comment ){
		// действия
	}
}

Аргументы параметра $args

user_id(число)

Вернет только комментарии указанного пользователя. Аналог параметра author__in.

По умолчанию: нет
author_email (строка)

email автора комментария, комментарии которого нужно получить.
По умолчанию: ''
author__in(число/массив)
ID автора, комментарии которого нужно получить. Можно указать ID нескольких авторов в массиве. В запросе используется поле user_id.
По умолчанию: ''
author__not_in(число/массив)
ID автора, комментарии которого нужно исключить. Можно указать ID нескольких авторов в массиве. В запросе используется поле user_id.
По умолчанию: ''
comment__in(массив/число)
ID комментариев которые нужно получить.
По умолчанию: ''
comment__not_in(массив/число)
ID комментариев которые нужно исключить.
По умолчанию: ''
count(число)
Вернет значение, общее число комментариев.
По умолчанию: нет
include_unapproved(массив)
Массив ID или email пользователей, неодобренные комментарии которых будут включены в результат, неважно какой статус бы указан в параметре status.
По умолчанию: ''
karma(число)
Получить комментарии с указанным числом karma.
По умолчанию: ''
parent(число)
ID комментария, дочерние комментарии которого нужно получить. Т.е. указывается родительский ID.
По умолчанию: ''
parent__in(массив)
Массив ID комментариев, дочерние комментарии которых нужно получить.
По умолчанию: array()
parent__not_in(массив)
ID комментариев, дочерние комментарии которых НЕ нужно получать.
По умолчанию: array()
post_author(число)
ID автора записи, комментарии которых нужно получить. В запросе используется поле post_author из таблицы записей wp_posts.
По умолчанию: ''
post_author__in(число/массив)
ID авторов записей, комментарии которых нужно получить. Можно указать ID нескольких авторов в массиве.
post_author__not_in(число/массив)
ID авторов записей, комментарии которых НЕ нужно получать. Можно указать ID нескольких авторов в массиве.
По умолчанию: ''
post_id(число)
ID поста/страницы. Если указать этот параметр, то функция вернет только комментарии к указанному посту или странице.
По умолчанию: ''
post__in(массив)
ID записей, комментарии которых нужно получить.
По умолчанию: ''
post__not_in(массив)
ID записей, комментарии которых нужно исключить.
По умолчанию: ''
post_status(строка)
Статус записи. Будут получены комментарии записей имеющих этот статус. Например publish.
По умолчанию: ''
post_type(строка)
Тип записи. Будут получены комментарии записей имеющих этот тип. Например page.
По умолчанию: ''
post_name(строка)
Название записи (ярлык записи), комментарии которой нужно получить.
По умолчанию: ''
post_parent(число)
ID записи, комментарии дочерних записей которой нужно получить.
По умолчанию: ''
search(строка)
Условия поиска, по которому будут получены комментарии.
По умолчанию: ''
status(строка)

Вернет комментарии с этим статусом. Может принимать параметры:

  • hold - не одобренные комменты
  • approve - одобренные комменты
  • spam - спам
  • trash - корзина
  • post-trashed - комментарии записей из корзины

По умолчанию: ''

orderby(строка/массив)

Поле из таблицы БД по которому нужно отсортировать вывод. Можно указывать несколько полей через пробел или запятую. Можно указывать метаданные комментария:

Поля основной таблицы (comments):

  • comment_agent
  • comment_approved
  • comment_author
  • comment_author_email
  • comment_author_IP
  • comment_author_url
  • comment_content
  • comment_date
  • comment_date_gmt
  • comment_ID
  • comment_karma
  • comment_parent
  • comment_post_ID
  • comment_type
  • user_id

Метаполя. При этом должен быть установлен параметр $meta_key:

  • meta_value
  • meta_value_num

Чтобы сортировать по определенному метаполю из параметра $meta_query, задайте индекс для запроса $meta_query, а тут впишите этот индекс.

Можно указать несколько полей в массиве. При этом в индексе нужно указать название поля, а в значении направление сортировки. Например: array('comment_date'=>'ASC', 'comment_karma'=>'DESC') Подробнее читайте здесь.

Можно указать false, array() или 'none', чтобы отключить часть запроса ORDER BY.

По умолчанию: 'comment_date_gmt'

order(строка)
Порядок сортировки: ASC (123), DESC (321). Игнорируется если в orderby указан ассоциативный массив.
По умолчанию: DESC
number(число)
Ограничения выводимых комментариев (укажите макс. число). Оставьте пустым, чтобы получить все комментарии.
По умолчанию: ''
offset(число)
Количество комментариев, которые нужно пропустить с начала (сверху результата). Используется для построения SQL LIMIT части запроса. Применяется для создания пагинации.
По умолчанию: 0
no_found_rows(логический)
Нужно ли отключить SQL_CALC_FOUND_ROWS в запросе.
По умолчанию: true
meta_key(строка)
Получить комментарии с указанным мета ключом.
По умолчанию: ''
meta_value(строка)
Получить комментарии с указанным значением метаполя. Должен быть указан параметр meta_key.
По умолчанию: ''
meta_query(массив)
Для создания сложных запросов по метаданным. Заменяет параметры meta_key и meta_value. Работает также как meta_query в WP_Query.
По умолчанию: ''
date_query(массив)
Фильтр по дате комментариев. Смотрите WP_Date_Query
По умолчанию: null
fields(строка)
Поля которые будут возвращены. Может быть ids - получит только ID комментариев, или пусто - получит все поля.
По умолчанию: ''
type(строка/массив)
Тип комментариев которые нужно получить. Можно указать несколько типов в массиве. Может быть: comment (равно ''), pings (включает pingback и trackback), или любой другой произвольный тип.
По умолчанию: '' (comment)
type__in(строка/массив)
Получить только комментарии с указанным типом.
По умолчанию: ''
type__not_in(строка/массив)
Получить все комментарии, кроме комментариев с указанным типом.
По умолчанию: ''
hierarchical(строка/логический)

Нужно ли включить дочерние комментарии в результат. Можно указать следующие параметры:

  • 'threaded' — вернет дерево со всеми дочерними комментариям, расположенными в свойстве children класса WP_Comment

  • 'flat' — вернет «плоский» массив, комментарии и их дочерние комментарии.

  • false — дочерние комментарии не будут включены в результат.

Параметр игнорируется (устанавливается в false), когда $fields = 'ids' или 'counts'.

По умолчанию: false

update_comment_meta_cache(логический)
Нужно ли сбросить мета-кэш для полученных комментариев?
По умолчанию: true
update_comment_post_cache(логический)
Нужно ли сбросить мета-кэш для записей (постов) комментариев?
По умолчанию: false

При использовании параметров типа post_* запрос строиться на базе таблицы записей wp_posts. И если например указать post_author__in, то будут получены все комментарии записей, авторами которых являются указанные пользователи.

А вот, если указать author__in, то будут получены отдельные комментарии указанных пользователей.

Добавлено в версии 4.4.0. Сортировка по полю comment__in. Параметры: $update_comment_meta_cache, $no_found_rows, $hierarchical, $update_comment_post_cache, $parent__in, $parent__not_in.

Примеры

#1. Выведет все комментарии к посту 15 (включая спам и не одобренные):

$comments = get_comments('post_id=15');
foreach($comments as $comment){
	echo($comment->comment_author);
}

#2. Покажет 5 не одобренных комментариев:

$args = array(
	'status' => 'hold',
	'number' => '5',
	'post_id' => 1, // правильно post_id, а не post_ID
);
$comments = get_comments($args);
foreach($comments as $comment){
	echo($comment->comment_author . '<br />' . $comment->comment_content);
}

#3. Выведем на экран количество комментариев поста:

$args = array(
	'post_id' => 1, // используйте post_id, а не post_ID
		'count' => true // возвращает только count
);
$comments = get_comments($args);
echo $comments;

#4. Выведем количество комментариев пользователя:

$args = array(
	'user_id' => 1,
		'count' => true
);
$comments = get_comments($args);
echo $comments

#5. Выведем комментарии пользователя:

$args = array(
	'user_id' => 1, // ID пользователя

);
$comments = get_comments($args);
foreach($comments as $comment){
	echo($comment->comment_author . '<br />' . $comment->comment_content);
}

#6. Удалим, идущие подряд, одинаковые комментарии (сравниваем автора и контент комментария):

// Получим все комментарии с пустым аргументом number
$all_comments = get_comments( array('status' => 'approve', 'number'=>'') );

// массив который будет содержать ID дублей комментариев
$comment_ids_to_delete=array();

foreach( $all_comments as $k=>$c )
{
	$kk = ($k-1); // Предыдущий индекс комментария в массиве $all_comments
	$pc = $all_comments[$kk]; // предыдущий объект комментария

	// Если автор и контент одинаковые, добавляем комментарий в массив для удаления
	if( $pc->comment_author == $c->comment_author && $pc->comment_content == $c->comment_content ){
		$comment_ids_to_delete[] = $pc->comment_ID;
	}
}

// Удаляем комментарии по ID
foreach($comment_ids_to_delete as $k=>$v){
	wp_delete_comment($v);
}

#7 Получим последние комментарии списком

Этот код получает последние 10 комментариев в виде списка UL. Где текст комментария укорочен до 50 символов и является ссылкой на сам комментарий:

$args = array(
	'number' => 10,
	'orderby' => 'comment_date',
	'order' => 'DESC',
	//'post_id' => 0,
	'type' => '', // только комментарии, без пингов и т.д...
);

if( $comments = get_comments( $args ) ){
	echo '<ul>';
	foreach( $comments as $comment ){
		$comm_link = get_comment_link( $comment->comment_ID ); // может быть тяжелый запрос ...
		$comm_short_txt = mb_substr( strip_tags( $comment->comment_content ), 0, 50 ) .'...';

		echo '<li>'. $comment->comment_author .': <a rel="nofollow" href="'. $comm_link .'">'. $comm_short_txt .'</a></li>';
	}
	echo '</ul>';
}

/*
Данные в объекте $comment
stdClass Object
(
	[comment_ID] => 9727
	[comment_post_ID] => 477
	[comment_author] => Andrew
	[comment_author_email] => mail@gmail.com
	[comment_author_url] => 
	[comment_author_IP] => 178.45.177.200
	[comment_date] => 2015-22-01 00:27:04
	[comment_date_gmt] => 2015-22-28 21:27:04
	[comment_content] => текст коммента
	[comment_karma] => 0
	[comment_approved] => 1
	[comment_agent] => Mozilla/5.0 (Windows NT 6.1; WOW64; rv:36.0) Gecko/20100101 Firefox/36.0
	[comment_type] => 
	[comment_parent] => 9724
	[user_id] => 313
)
*/

Код get comments: wp-includes/comment.php WP 4.9

<?php
function get_comments( $args = '' ) {
	$query = new WP_Comment_Query;
	return $query->query( $args );
}

Cвязанные функции

Из раздела: Комментарии

Www.newsystems.ru

Ремонт и обслуживание сплит систем на сайте www.newsystems.ru.

newsystems.ru

get_comments 15 комментариев
Вопросы 1 Все
  • Павлуха cайт: pavluha.net

    Странная странность: указываю в параметрах

    '&status=approve&type='

    , а функция всё равно комменты вместе с пинг-бэками возвращает, хотя у пинг-бэков type = pingback. Наугад просто написал

    '&status=approve&type=comment'
    • выбрались только комменты без пинг-бэков. Оставил так smile
    Ответить3 года назад #
    • Kama4660

      Ничего странного: type= равносильно тому что вы вообще не указали type.

      Ответить3 года назад #
      • Павлуха cайт: pavluha.net

        Равносильно - это да. Потому как, если даже не указывать type, он по умолчанию 'type' => ''. Но у комментов же такой type - пустая строка, а вот у пингбэков он 'pingback'. Разве не странно, что ф-я с пустым type возвращает все типы комментов, а с каким-то наугад указанным 'type' => 'comment' возвращает только комментарии? Да лишь бы только с очередным обновлением WP функция с параметром type=comment не начала в базе искать такие комменты, у которых в поле type написано comment.

        Ответить3 года назад #
        • Kama4660

          Сейчас глянул, там в запросе есть такая проверка... Я не думаю, что это случайность и что это изменится в будущем...

          if ( 'comment' == $this->query_vars['type'] ) {
          	$where .= " AND comment_type = ''";
          } elseif( 'pings' == $this->query_vars['type'] ) {
          	$where .= ' AND comment_type IN ("pingback", "trackback")';
          } elseif ( ! empty( $this->query_vars['type'] ) ) {
          	$where .= $wpdb->prepare( ' AND comment_type = %s', $this->query_vars['type'] );
          }
          Ответить3 года назад #
          • Павлуха cайт: pavluha.net

            Теперь понятно. Спасибо!

            Ответить3 года назад #
  • sergey666 cайт: ytcolor.ru

    кама, помоги smile проблема с выводом комментариев, при обновлении страницы (запись) комментарий пропадает или вообще выскакивает с рандомной записи. я весь код перерыл, покавырялся в плагинах, не понимаю в чем проблема.
    кстати, проблема почему-то не распространяется на "страницы", только на "записи".

    Ответить2.9 года назад #
  • Илья

    Добрый день. А как добавить к выведенному коментарию имя поста к которому он принадлежит? Всю голову уже сломал. Пособите пожалуйста...

    Ответить2.6 года назад #
    • Kama4660

      Это будет дополнительный запрос, но вот так:

      // в цикле вывода данных о комментарии $comment
      $comment_post_title = get_the_title( $comment->comment_post_ID );
      echo $comment_post_title;
      Ответить2.6 года назад #
  • staleer

    а как вывести на главную последние комментарии со всех постов?

    Ответить2.5 года назад #
  • Константин

    Подскажите, пожалуйста, можно ли через comment_post_ID получить название статьи в которой размещен комментарий.Нужно вывести, к примеру ' Константин к статье "Вывод комментарий на главной странице" '

    Ответить1.7 года назад #
    • Константин

      Сделал: $post_id = get_post($comment->comment_post_ID); Может у кого-то возникнет подобная задача.

      Ответить1.7 года назад #
  • Артем @

    Уважаемый Kama. Спасибо тебе за сайт один из самых полезных ресурсов по WP.

    Такой вопрос клиенту нужна возможно выводить на нескольких страницах один и тот же список комментариев. То есть Страницы 1,2,3 например пишет человек коммент на странице 1 зайдя на другие связанные страницы он видит те же комментарии что и на других. Не знаю смог ли объяснить Можно ли реализовать это в WP? может есть плагин? или код поделись пожалуйста или дай направление.

    1
    Ответитьгод назад #

Здравствуйте, !

Ваш комментарий