get_comment_pages_count() │ WP 2.7.0

Підраховує кількість сторінок коментарів біля посту (на скільки сторінок розбито коментарі).

Дозволяє порахувати скільки сторінок коментарів вийде, якщо враховувати кількість коментарів на сторінку та їхній деревоподібний висновок.

Зазвичай, цю функцію не використовують перед початком циклу коментарів.

Функцію можна використовувати поза циклу. Тоді потрібно вказати параметр $comments, і $per_page, $threaded за потребою.

Основа для:
get_next_comments_link() ,
get_the_comments_navigation()

Хуків немає.

Повертає

int. Кількість сторінок коментарів

Використання

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 = новий 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 6.0.2}

wp-includes/comment.php

function get_comment_pages_count( $comments = null, $per_page = null, $threaded = null ) {
	global $wp_query;

	if ( null === $comments && null === $per_page && null === $threaded && ! empty( $wp_query->max_num_comment_pages ) ) {
		return $wp_query->max_num_comment_pages;
	}

	if ( ( ! $comments || ! is_array( $comments ) ) && ! empty( $wp_query->comments ) ) {
		$comments = $wp_query->comments;
	}

	if ( empty( $comments ) ) {
		return 0;
	}

	if ( ! get_option( 'page_comments' ) ) {
		return 1;
	}

	if ( ! isset ( $ per_page ) ) {
		$per_page = (int) get_query_var( 'comments_per_page' );
	}
	if ( 0 === $per_page ) {
		$per_page = (int) get_option( 'comments_per_page' );
	}
	if ( 0 === $per_page ) {
		return 1;
	}

	if ( ! isset ( $ threaded ) ) {
		$threaded = get_option( 'thread_comments');
	}

	if ($ threaded) {
		$walker = новий Walker_Comment;
		$count = ceil( $walker->get_number_of_root_elements( $comments ) / $per_page );
	} else {
		$ count = ceil ( count ( $ comments ) / $ per_page );
	}

	return $count;
}

get_comment_pages_count() │ WP 2.7.0

Повертає

Використання

Приклади

#1 Приклад використання функції у циклі:

#2 Приклад використання довільних параметрів

#3 Використання функції за межами циклу коментарів

нотатки

список змін

get comment pages count WP 6.0.2

Зв’язані функції

Пагінація коментарів (навігація)

comment (коментарі)

Коментарі

Залишити відповідь Скасувати коментар

get comment pages count ^{WP 6.0.2}