get_comment_pages_count() WP 2.7
Подсчитывает количество страниц комментариев у поста (на сколько страниц разбиты комментарии).
Позволяет посчитать сколько страниц комментариев получится, если учитывать количество комментариев на страницу и их древовидный вывод.
Обычно эту функцию не используют перед началом цикла комментариев.
Функцию можно использовать за пределами цикла. Тогда, нужно указать параметр $comments, и $per_page, $threaded по необходимости.
get_next_comments_link()
, get_the_comments_navigation()
Хуков нет.
Возвращает
Число. Количество страниц комментариев.
Использование
get_comment_pages_count( $comments, $per_page, $threaded );
- $comments(массив)
- Массив объектов с комментариями. По умолчанию используется глобальная переменная
$wp_query->comments
.
По умолчанию: null - $per_page(число)
- Сколько комментариев выводить на одну страницу. По умолчанию берется из настроек.
По умолчанию: null - $threaded(логический)
Учитывать древовидность комментариев или нет. По умолчанию берется из настроек. Может быть:
- false - не учитывать, считать каждый комментарий.
- true - учитывать дерево комментариев, считать все дерево как один комментарий.
По умолчанию: null
Примеры
#1. Пример использования функции в цикле:
$pages = get_comment_pages_count();
#2. Пример использования произвольных параметров
Пример выше использует все значения по умолчанию, которые берутся из настроек. А этот пример показывает как работают свои параметры:
// страниц комментариев, если 25 комментариев на страницу. $pages = get_comment_pages_count( null, 25 ); // страниц комментариев, если не делить комментарии на древовидные. $pages = get_comment_pages_count( null, null, false ); // страниц комментариев, если по 10 на страницу и они древовидные $pages = get_comment_pages_count( null, 10, true );
3. Использование функции за пределами цикла комментариев
Если функция используется за пределами цикла комментариев, то нужно указать параметр $comment, который содержит массив комментариев для подсчета. Такой массив можно получить по нужным аргументам, с помощью класса: WP_Comment_Query.
Получим комментарии по нужным параметрам и узнаем на сколько страниц они разобьются:
$args = array( // query args here ); $comments_query = new WP_Comment_Query; $comments = $comments_query->query( $args ); $pages = get_comment_pages_count( $comments );
Заметки
- Global. WP_Query.
$wp_query
WordPress Query object.
Список изменений
С версии 2.7.0 | Введена. |
Код get comment pages count:
wp-includes/comment.php
WP 5.3
Cвязанные функции
Из метки: Пагинация комментариев (навигация)
Еще из метки: comment (комментарии)
- comment_link()
- comments_template()
- get_comment_author()
- get_comment_author_link()
- get_comment_author_url()
Еще из раздела: Комментарии
- cancel_comment_reply_link()
- comment_author_email_link()
- comment_form()
- comment_form_title()
- comment_id_fields()
- comment_text()
- comment_type()
- comments_link()
- comments_number()
- comments_popup_link()
- get_avatar()
- get_avatar_data()
- get_avatar_url()