wp_link_pages()

Форматированный вывод списка страниц
Функция WordPress
INT 1.2.0
WordPress Icon
Содержание
  1. Описание функции
  2. Примеры использования
  3. Форматирование списка страниц
  4. Добавление префикса и суффикса к каждой ссылке
  5. Изменение текста ссылок на страницы
  6. Использование числовых значений вместо ссылок
  7. Изменение разделителя между ссылками
  8. Вопросы и ответы
  9. Как изменить текст ссылки на следующую страницу?
  10. Как изменить текст ссылки на предыдущую страницу?
  11. Как изменить формат номеров страниц?
  12. Как добавить свой класс к ссылкам на страницы?
  13. Как изменить разделитель между ссылками на страницы?
  14. Как скрыть ссылку на текущую страницу?
  15. Как изменить значение атрибута aria-current?
  16. Как изменить общий HTML-код ссылок на страницы?
  17. Как отключить вывод функции wp_link_pages()?
  18. Связанные элементы

Описание функции

Функция wp_link_pages() форматирует и выводит список страниц, связанных с текущим постом или страницей. Она создает пагинацию для разбиения контента на несколько страниц.

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

wp_link_pages( string|array $args = '' ): string

Функция wp_link_pages() принимает один необязательный параметр $args, который может быть строкой или массивом аргументов. Она возвращает отформатированный вывод в виде HTML.

  • $args (строка или массив): Массив или строка с аргументами по умолчанию.
  • before (строка): HTML или текст, добавляемый перед каждой ссылкой. По умолчанию: «Pages:».
  • after (строка): HTML или текст, добавляемый после каждой ссылки. По умолчанию: пустая строка.
  • link_before (строка): HTML или текст, добавляемый перед каждой ссылкой внутри тега <a>. Также добавляется перед текущим элементом, который не является ссылкой. По умолчанию: пустая строка.
  • link_after (строка): HTML или текст, добавляемый после каждой ссылки на страницы внутри тега <a>. Также добавляется после текущего элемента, который не является ссылкой. По умолчанию: пустая строка.
  • aria_current (строка): Значение атрибута aria-current. Возможные значения: ‘page’, ‘step’, ‘location’, ‘date’, ‘time’, ‘true’, ‘false’. По умолчанию: ‘page’.
  • next_or_number (строка): Определяет, должны ли использоваться номера страниц или ссылки «Next» и «Previous». Допустимые значения: ‘number’, ‘next’. По умолчанию: ‘number’.
  • separator (строка): Текст между ссылками пагинации. По умолчанию: пробел.
  • nextpagelink (строка): Текст ссылки на следующую страницу, если она доступна. По умолчанию: «Next Page».
  • previouspagelink (строка): Текст ссылки на предыдущую страницу, если она доступна. По умолчанию: «Previous Page».
  • pagelink (строка): Формат строки для номеров страниц. Знак % в строке будет заменен номером страницы, например, ‘Page %’ создаст «Page 1», «Page 2» и т.д. По умолчанию: ‘%’, только номер страницы.
  • echo (int|bool): Определяет, нужно ли вывести результат на экран. Принимает значения 1|true или 0|false. По умолчанию: 1|true.

Функция возвращает отформатированный вывод в виде HTML.

<?php
$args = array(
    'before' => '<p>Pages: </p>',
    'nextpagelink' => '<span class="next-page">Next Page</span>',
    'previouspagelink' => '<span class="prev-page">Previous Page</span>',
    'pagelink' => 'Page %',
    'echo' => false
);
$pagination = wp_link_pages($args);
echo '<div class="pagination">' . $pagination . '</div>';
?>

В этом примере мы создаем массив $args с различными параметрами для функции wp_link_pages(). Затем мы вызываем функцию с этими аргументами и сохраняем результат в переменную $pagination. Наконец, мы выводим пагинацию внутри контейнера <div class="pagination">.

Примеры использования

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


$args = array(
    'before' => '<div class="page-links">' . __( 'Pages:', 'textdomain' ),
    'after'  => '</div>',
);
 
wp_link_pages( $args );

В данном примере кода используется функция wp_link_pages() для вывода отформатированного списка страниц. В параметре $args передается массив с опциями форматирования. В данном случае, используется опция before для добавления префикса к каждой ссылке и опция after для добавления суффикса. Результатом выполнения кода будет отформатированный список страниц с префиксом «Pages:».

Добавление префикса и суффикса к каждой ссылке


$args = array(
    'link_before' => '<span class="page-link-text">',
    'link_after'  => '</span>',
);
 
wp_link_pages( $args );

В данном примере кода используется функция wp_link_pages() для вывода списка страниц. В параметре $args передается массив с опциями форматирования. В данном случае, используется опция link_before для добавления префикса к каждой ссылке и опция link_after для добавления суффикса. Результатом выполнения кода будет список страниц, где каждая ссылка будет обернута в тег <span> с классом «page-link-text».

Изменение текста ссылок на страницы


$args = array(
    'nextpagelink'     => __( 'Next Page', 'textdomain' ),
    'previouspagelink' => __( 'Previous Page', 'textdomain' ),
);
 
wp_link_pages( $args );

В данном примере кода используется функция wp_link_pages() для вывода списка страниц. В параметре $args передается массив с опциями форматирования. В данном случае, используются опции nextpagelink и previouspagelink для изменения текста ссылок на следующую и предыдущую страницы соответственно. Результатом выполнения кода будет список страниц с измененным текстом ссылок.

Использование числовых значений вместо ссылок


$args = array(
    'next_or_number' => 'number',
);
 
wp_link_pages( $args );

В данном примере кода используется функция wp_link_pages() для вывода списка страниц. В параметре $args передается массив с опциями форматирования. В данном случае, используется опция next_or_number со значением «number», что означает использование числовых значений вместо ссылок. Результатом выполнения кода будет список страниц, где вместо ссылок будут отображаться числовые значения.

Изменение разделителя между ссылками


$args = array(
    'separator' => ' | ',
);
 
wp_link_pages( $args );

В данном примере кода используется функция wp_link_pages() для вывода списка страниц. В параметре $args передается массив с опциями форматирования. В данном случае, используется опция separator со значением » | «, что означает использование вертикальной черты в качестве разделителя между ссылками. Результатом выполнения кода будет список страниц с измененным разделителем.

Вопросы и ответы

Как изменить текст ссылки на следующую страницу?

Для изменения текста ссылки на следующую страницу используется параметр nextpagelink. По умолчанию текст ссылки установлен как «Next Page». Чтобы изменить его, нужно передать новое значение в функцию wp_link_pages().


$args = array(
    'nextpagelink' => 'Следующая страница',
);
wp_link_pages($args);

Как изменить текст ссылки на предыдущую страницу?

Для изменения текста ссылки на предыдущую страницу используется параметр previouspagelink. По умолчанию текст ссылки установлен как «Previous Page». Чтобы изменить его, нужно передать новое значение в функцию wp_link_pages().


$args = array(
    'previouspagelink' => 'Предыдущая страница',
);
wp_link_pages($args);

Как изменить формат номеров страниц?

Для изменения формата номеров страниц используется параметр pagelink. По умолчанию формат установлен как «%», что означает просто номер страницы. Чтобы изменить формат, нужно передать новую строку формата в функцию wp_link_pages(). В этой строке символ «%» будет заменен на номер страницы.


$args = array(
    'pagelink' => 'Страница %',
);
wp_link_pages($args);

Как добавить свой класс к ссылкам на страницы?

Для добавления своего класса к ссылкам на страницы в функции wp_link_pages() необходимо использовать параметр link_before. В этом параметре можно указать HTML или текст, который будет добавлен перед каждой ссылкой.


$args = array(
    'link_before' => '<span class="my-class">',
    'link_after' => '</span>'
);
wp_link_pages($args);

Как изменить разделитель между ссылками на страницы?

Для изменения разделителя между ссылками на страницы в функции wp_link_pages() необходимо использовать параметр separator. В этом параметре можно указать текст, который будет использоваться в качестве разделителя.


$args = array(
    'separator' => ' | '
);
wp_link_pages($args);

Как скрыть ссылку на текущую страницу?

Для скрытия ссылки на текущую страницу в функции wp_link_pages() необходимо использовать параметр link_before и link_after. В этих параметрах можно указать HTML или текст, который будет добавлен перед и после текущей страницы, которая не будет являться ссылкой.


$args = array(
    'link_before' => '<span class="current-page">',
    'link_after' => '</span>'
);
wp_link_pages($args);

Как изменить значение атрибута aria-current?

Значение атрибута aria-current можно изменить, указав его в параметре aria_current при вызове функции wp_link_pages(). По умолчанию значение атрибута равно 'page'. Допустимые значения: 'page', 'step', 'location', 'date', 'time', 'true', 'false'.


$args = array(
    'aria_current' => 'location'
);
wp_link_pages($args);

Как изменить общий HTML-код ссылок на страницы?

Общий HTML-код ссылок на страницы можно изменить, указав его в параметрах before, after, link_before и link_after при вызове функции wp_link_pages(). По умолчанию значения этих параметров равны пустой строке.


$args = array(
    'before' => '<div class="pagination">',
    'after' => '</div>',
    'link_before' => '<span class="page-link">',
    'link_after' => '</span>'
);
wp_link_pages($args);

Вывод функции wp_link_pages() можно отключить, указав параметр echo со значением 0 или false при вызове функции. По умолчанию значение параметра равно 1 или true.


$args = array(
    'echo' => 0
);
$pagination = wp_link_pages($args);

Функция wp_link_pages() предоставляет возможность форматированного вывода списка страниц. Она позволяет изменять значение атрибута aria-current, общий HTML-код ссылок на страницы и отключать вывод функции. Это полезный инструмент для разработчиков WordPress, позволяющий управлять пагинацией в постах и страницах.

Связанные элементы

  • Функция get_adjacent_post(): возвращает объект предыдущего или следующего поста.
  • Функция get_boundary_post(): возвращает объект первого или последнего поста.
  • Функция get_edit_post_link(): возвращает ссылку для редактирования поста.
  • Функция get_next_posts_link(): возвращает ссылку на следующую страницу постов.
  • Функция get_permalink(): возвращает ссылку на пост.
  • Функция get_previous_posts_link(): возвращает ссылку на предыдущую страницу постов.
  • Функция get_the_category(): возвращает массив категорий текущего поста.
  • Функция get_the_tags(): возвращает массив тегов текущего поста.
  • Функция has_post_thumbnail(): проверяет, есть ли у поста миниатюра.
Ссылки Страницы
Обсуждение

Этот сайт использует cookie для хранения данных. Продолжая использовать сайт, Вы принимаете условия пользовательского соглашения и даете свое согласие на использование cookie.