› Все функции › Функции › Тема (шаблон) › Архивы ›

paginate_links() WP 2.1.0

Выводит ссылки пагинации для страниц архивов. Может быть использована для создания пагинации у любых страниц.

Технически функцию можно использовать для создания пагинации где угодно. Параметр base используется как ссылка на УРЛ, которая будет использована для создания ссылки пагинации. Параметр format будет заменен на номер пагинации. Эта функция является ядром для всех функций пагинации в WordPress.

Для построения пагинации в WordPress есть специальные фукнции-обертки для этой функции:

Параметр type контролирует в каком формате будет возвращен результат:

plain- просто ссылки разделенные переносом строки (По умолчанию).
array - в виде массива данных для дальнейшей обработки в PHP
list - <ul> список.

Числовой параметр total должен получить общее количество страниц пагинации, а параметр current номер текущей страницы пагинации. Пример параметра base - http://example.com/all_posts.php%_%, где %_% - обязательная часть, которая будет заменена тем что указано в параметре format. Пример format - ?page=%#%, здесь %#%, также обязательная часть, которая будет заменена числом текущей страницы пагинации. Вообще, в base можно сразу указать например так: http://example.com/all_posts.php?page=%#%, а в формат пусто ('').

Чтобы добавить ссылки на предыдущую/следующую страницу, нужно включить логический параметр prev_next (указать ему true), а затем можно установить текст ссылок указав параметры prev_text/next_text (предыдущая ссылка/следующая ссылка).

Если включить параметр show_all, то будут выведены абсолютно все ссылки пагинации, вместо нескольких ссылок вокруг текущей и нескольких конечных ссылок. По умолчанию, этот параметр выключен, а сколько ссылок показывать вокруг текущей страницы и на концах контролируется параметрами: end_size и mid_size.

Также есть возможность добавить в ссылки переменные запроса, для этого укажите нужные переменные и их значения в виде массива в параметр add_args. Подробнее см. функцию add_query_arg().

Параметры before_page_number и after_page_number позволяют обернуть само число пагинации, например в <span> для стилизации. А вообще, эти параметры были созданы для того, чтобы указать текст для роботов, чтобы при просмотре кода, было понятно для чего предназначены ссылки.

В результате вы получите нечто подобное: « предыдущая 1 … 3 4 5 6 7 … 9 следующая »

Является основой для: get_the_posts_pagination(), paginate_comments_links()

Хуки из функции

paginate_links

Возвращает

HTML код.

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

<?php echo paginate_links( $args ) ?>

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

$args = array(
	'base'         => '%_%',
	'format'       => '?page=%#%',
	'total'        => 1,
	'current'      => 0,
	'show_all'     => False,
	'end_size'     => 1,
	'mid_size'     => 2,
	'prev_next'    => True,
	'prev_text'    => __('« Previous'),
	'next_text'    => __('Next »'),
	'type'         => 'plain',
	'add_args'     => False,
	'add_fragment' => '',
	'before_page_number' => '',
	'after_page_number'  => ''
); 

echo paginate_links( $args );

$args(строка/массив): Аргументы для построения пагинации.
По умолчанию: предустановки

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

base(строка)

База для замены по формату. В конструкции: http://example.com/all_posts.php%_% %_% будет заменено значением аргумента format (см. ниже).
По умолчанию: '%_%'

format(строка)

Формат замены.
По умолчанию: '?page=%#%'

total(число)

Общее количество страниц, которые участвуют в пагинации.
По умолчанию: 1

current(число)

Номер текущей страницы пагинации.

show_all(логический)

Если выставить в true, то в списке ссылок будут показаны все страницы участвующие в пагинации. По умолчанию показывается только несколько ссылок спереди и сзади номера текущей страницы, количество ссылок регулируется аргументами: end_size и mid_size.
По умолчанию: false

end_size(число)

Сколько номеров показывать сначала и конца ("предыдущая 12 ... 4 ... 89 следующая").
По умолчанию: 1

mid_size(число)

Сколько номеров показывать до и после текущего номера (... 123 5 678 ...).
По умолчанию: 2

prev_next(логический)

Выводить боковые ссылки "предыдущая/следующая страница". По умолчанию выводятся, если ненужно выводить эти ссылки пишем false.
По умолчанию: true

prev_text(строка)

Текст ссылки "предыдущая страница".
По умолчанию: __('« Previous')

next_text(строка)

Текст ссылки "следующая страница".
По умолчанию: __('Next »')

type(строка)

Формат возвращаемых данных.

plain — строка ссылок разделенная пробелами. По умолчанию;
array — массив данных (для дальнейшей обработки);
list — html список <ul>.
По умолчанию: 'plain'

add_args(логический)

Массив аргументов (переменных запроса), которые нужно добавить к ссылкам.
По умолчанию: false

add_fragment(строка)

Текст который добавиться ко всем ссылкам.
По умолчанию: ''

aria_current(строка)

Значение атрибута aria-current. Возможные значения: 'page', 'step', 'location', 'date', 'time', 'true', 'false'. С версии 4.9.
По умолчанию: 'page'.

Примеры

#1 Пагинация, аналог `wp_pagenavi`

Чтобы добавить пагинацию на страницу результатов поиска или страницу архивов, используйте такой код:

function my_pagenavi() {
	global $wp_query;

	$big = 999999999; // уникальное число для замены

	$args = array(
		'base'    => str_replace( $big, '%#%', get_pagenum_link( $big ) ),
		'format'  => '',
		'current' => max( 1, get_query_var('paged') ),
		'total'   => $wp_query->max_num_pages,
	);

	$result = paginate_links( $args );

	// удаляем добавку к пагинации для первой страницы
	$result = preg_replace( '~/page/1/?([\'"])~', '\1', $result );

	echo $result;
}

// Теперь, где нужно вывести пагинацию используем 
// my_pagenavi();

#2 Пример с произвольным запросом WP_Query

Когда записи получаются и выводятся отдельным запросом с помощью new WP_Query установите в параметр total свойство $max_num_pages. На примере:

Наш произвольный запрос и пагинация для него:

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

<?php
// 1 значение по умолчанию
$paged = get_query_var( 'paged' ) ? absint( get_query_var( 'paged' ) ) : 1;

$the_query = new WP_Query( array(
	'posts_per_page' => 5,
	'category_name'  => 'gallery',
	'paged'          => $paged,
) );

// цикл вывода полученных записей
while( $the_query->have_posts() ){
	$the_query->the_post();
	?>
	<!-- HTML каждой записи -->
	<?php 
} 
wp_reset_postdata();

// пагинация для произвольного запроса
$big = 999999999; // уникальное число

echo paginate_links( array(
	'base'    => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ),
	'format'  => '?paged=%#%',
	'current' => max( 1, get_query_var('paged') ),
	'total'   => $the_query->max_num_pages
) );
?>

Заметки

Global. WP_Query. $wp_query WordPress Query object.
Global. WP_Rewrite. $wp_rewrite WordPress rewrite component.

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

С версии 2.1.0	Введена.
С версии 4.9.0	Added the `aria_current` argument.

Код paginate links: `wp-includes/general-template.php` ^{WP 5.3.2}

<?php
function paginate_links( $args = '' ) {
	global $wp_query, $wp_rewrite;

	// Setting up default values based on the current URL.
	$pagenum_link = html_entity_decode( get_pagenum_link() );
	$url_parts    = explode( '?', $pagenum_link );

	// Get max pages and current page out of the current query, if available.
	$total   = isset( $wp_query->max_num_pages ) ? $wp_query->max_num_pages : 1;
	$current = get_query_var( 'paged' ) ? intval( get_query_var( 'paged' ) ) : 1;

	// Append the format placeholder to the base URL.
	$pagenum_link = trailingslashit( $url_parts[0] ) . '%_%';

	// URL base depends on permalink settings.
	$format  = $wp_rewrite->using_index_permalinks() && ! strpos( $pagenum_link, 'index.php' ) ? 'index.php/' : '';
	$format .= $wp_rewrite->using_permalinks() ? user_trailingslashit( $wp_rewrite->pagination_base . '/%#%', 'paged' ) : '?paged=%#%';

	$defaults = array(
		'base'               => $pagenum_link, // http://example.com/all_posts.php%_% : %_% is replaced by format (below)
		'format'             => $format, // ?page=%#% : %#% is replaced by the page number
		'total'              => $total,
		'current'            => $current,
		'aria_current'       => 'page',
		'show_all'           => false,
		'prev_next'          => true,
		'prev_text'          => __( '&laquo; Previous' ),
		'next_text'          => __( 'Next &raquo;' ),
		'end_size'           => 1,
		'mid_size'           => 2,
		'type'               => 'plain',
		'add_args'           => array(), // array of query args to add
		'add_fragment'       => '',
		'before_page_number' => '',
		'after_page_number'  => '',
	);

	$args = wp_parse_args( $args, $defaults );

	if ( ! is_array( $args['add_args'] ) ) {
		$args['add_args'] = array();
	}

	// Merge additional query vars found in the original URL into 'add_args' array.
	if ( isset( $url_parts[1] ) ) {
		// Find the format argument.
		$format       = explode( '?', str_replace( '%_%', $args['format'], $args['base'] ) );
		$format_query = isset( $format[1] ) ? $format[1] : '';
		wp_parse_str( $format_query, $format_args );

		// Find the query args of the requested URL.
		wp_parse_str( $url_parts[1], $url_query_args );

		// Remove the format argument from the array of query arguments, to avoid overwriting custom format.
		foreach ( $format_args as $format_arg => $format_arg_value ) {
			unset( $url_query_args[ $format_arg ] );
		}

		$args['add_args'] = array_merge( $args['add_args'], urlencode_deep( $url_query_args ) );
	}

	// Who knows what else people pass in $args
	$total = (int) $args['total'];
	if ( $total < 2 ) {
		return;
	}
	$current  = (int) $args['current'];
	$end_size = (int) $args['end_size']; // Out of bounds?  Make it the default.
	if ( $end_size < 1 ) {
		$end_size = 1;
	}
	$mid_size = (int) $args['mid_size'];
	if ( $mid_size < 0 ) {
		$mid_size = 2;
	}

	$add_args   = $args['add_args'];
	$r          = '';
	$page_links = array();
	$dots       = false;

	if ( $args['prev_next'] && $current && 1 < $current ) :
		$link = str_replace( '%_%', 2 == $current ? '' : $args['format'], $args['base'] );
		$link = str_replace( '%#%', $current - 1, $link );
		if ( $add_args ) {
			$link = add_query_arg( $add_args, $link );
		}
		$link .= $args['add_fragment'];

		$page_links[] = sprintf(
			'<a class="prev page-numbers" href="%s">%s</a>',
			/**
			 * Filters the paginated links for the given archive pages.
			 *
			 * @since 3.0.0
			 *
			 * @param string $link The paginated link URL.
			 */
			esc_url( apply_filters( 'paginate_links', $link ) ),
			$args['prev_text']
		);
	endif;

	for ( $n = 1; $n <= $total; $n++ ) :
		if ( $n == $current ) :
			$page_links[] = sprintf(
				'<span aria-current="%s" class="page-numbers current">%s</span>',
				esc_attr( $args['aria_current'] ),
				$args['before_page_number'] . number_format_i18n( $n ) . $args['after_page_number']
			);

			$dots = true;
		else :
			if ( $args['show_all'] || ( $n <= $end_size || ( $current && $n >= $current - $mid_size && $n <= $current + $mid_size ) || $n > $total - $end_size ) ) :
				$link = str_replace( '%_%', 1 == $n ? '' : $args['format'], $args['base'] );
				$link = str_replace( '%#%', $n, $link );
				if ( $add_args ) {
					$link = add_query_arg( $add_args, $link );
				}
				$link .= $args['add_fragment'];

				$page_links[] = sprintf(
					'<a class="page-numbers" href="%s">%s</a>',
					/** This filter is documented in wp-includes/general-template.php */
					esc_url( apply_filters( 'paginate_links', $link ) ),
					$args['before_page_number'] . number_format_i18n( $n ) . $args['after_page_number']
				);

				$dots = true;
			elseif ( $dots && ! $args['show_all'] ) :
				$page_links[] = '<span class="page-numbers dots">' . __( '&hellip;' ) . '</span>';

				$dots = false;
			endif;
		endif;
	endfor;

	if ( $args['prev_next'] && $current && $current < $total ) :
		$link = str_replace( '%_%', $args['format'], $args['base'] );
		$link = str_replace( '%#%', $current + 1, $link );
		if ( $add_args ) {
			$link = add_query_arg( $add_args, $link );
		}
		$link .= $args['add_fragment'];

		$page_links[] = sprintf(
			'<a class="next page-numbers" href="%s">%s</a>',
			/** This filter is documented in wp-includes/general-template.php */
			esc_url( apply_filters( 'paginate_links', $link ) ),
			$args['next_text']
		);
	endif;

	switch ( $args['type'] ) {
		case 'array':
			return $page_links;

		case 'list':
			$r .= "<ul class='page-numbers'>\n\t<li>";
			$r .= join( "</li>\n\t<li>", $page_links );
			$r .= "</li>\n</ul>\n";
			break;

		default:
			$r = join( "\n", $page_links );
			break;
	}

	return $r;
}

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

Из раздела: Архивы

Kama и campusboy13 Апр 2019 . 28 Апр 2011 41 коммент

41 коммент

Полезные 3 Вопросы 1 Все

unskill

Второй пример очень помог. Спасибо.

1

Ответить04.Май.2018 в 15:03 #
Руслан
Большое спасибо за эту подсказку)
```
// удаляем добавку к пагинации для первой страницы
$result = str_replace( '/page/1/', '', $result );
```
Пробовал вначале через add_filter(), только он вызывался слишком рано.

Единственно, если адреса на сайте оканчиваются на /, то первым аргументом str_replace() нужно сделать 'page/1/' - без слеша вначале
Ответить13.Сен.2018 в 09:43 #
Oleksandr

Спасибо большое! То, что нужно! С Add_filter - не получалось никакими способами.

Ответить31.Окт.2018 в 15:31 #
@ Александр
```
$result = str_replace( '/page/1/', '', $result );
```
Да все круто, но если есть пагинация для 10-й страницы, то не работает, удаляет часть ссылки.
-1

Ответить21.Дек.2018 в 16:21 #
- Kama7599
  
  Каким образом?
  
  Ответить21.Дек.2018 в 22:16 #
  - @ Александр
    Это только в том случае, если с урлов убираем последний /
    
    /page/1 имеется и в 10 странице пагинации
    
    /page/10/
    
    соответсвенно 10 и последующие страницы пагинации выведет вот так
    
    blog0 (10 страница)
    blog1 (11 страница)
    
    после дебага, выявил что paginate_links( $args ) печатает в некоторых случаях одинарные кавычки а не двойные
    соответственно код типа
    
    $result = str_replace( '/page/1"', '"', $result );
    
    не помогал
    
    в итоге пришлось сделать так
    
    $result = paginate_links( $args ); $result = str_replace("'", '"', $result); $result = str_replace( '/page/1"', '"', $result );
    
    теперь заменяется ссылка только на первую страницу
    Ответить21.Дек.2018 в 23:20 #
    - Kama7599
      
      Так каким образом код:
      
      $result = str_replace( '/page/1/', '', $result );
      
      Удаляет часть ссылки?
      
      -
      
      Можно проще записать:
      
      $result = str_replace( "/page/1'", "'", $result );
      
      -
      
      Изменил в статье код на универсальный, спасибо за комменты:
      
      $result = preg_replace( '~/page/1/?([\'"])~', '\1', $result );
      
      Ответить22.Дек.2018 в 10:09 #
Nester3

Обращаю Ваше внимание, что если логический параметр no_found_rows стоит в true, то всегда max_num_pages=0. В некоторых случаях может ускорить процесс выборки, так как не производиться подсчет найденных строк.

P.S. То бишь, если во второй пример установить no_found_rows => true, то $the_query->max_num_pages всегда будет 0.

2

Ответить06.Янв.2019 в 17:00 #
@ Дмитрий

Доброго времени! Не подскажите как можно реализовать чтобы было вот так

Назад / 1 из 100 / Вперед

Т.е. сама загвоздка получается что я не могу вставить "1 из 100" в середину кнопок, а остальное вроде как понятно как реализовать.

Ответить13.Мар.2019 в 14:04 #