Шорткоды

Весь функционал плагина ABC Pagination работает через шорткод.

[abc_pagination]

По умолчанию, если вы не указали никаких параметров — шорткод выведет алфавитный указатель по всем записям на вашем сайте. Поэтому вместе с шорткодом мы обычно указываем дополнительные атрибуты, для выборки записей из определенной рубрики, тега и т.д.

Например, для выборки записей из рубрики с ID 3, нам нужно добавить атрибут cat:

[abc_pagination cat="3"]

С версии плагина 1.3.0 вместо записей можно выводить таксономии (рубрики, метки и т.д.) с помощью атрибута taxonomy.

Например, для вывода всех рубрик сайта, используйте шорткод:

[abc_pagination taxonomy="category"]

Для вывода всех меток сайта, используйте шорткод:

[abc_pagination taxonomy="post_tag"]

В качестве значения данного атрибута можно указывать ярлык произвольной таксономии.

Атрибуты задаются через пробел, значение атрибута задается в кавычках.

Ниже будет приведен список всех атрибутов, их значение по умолчанию и описание. Вы указываете только те атрибуты, которые будут отличаться от значения по умолчанию.

Настройки

Атрибуты для фильтрации совпадают с аргументами get_posts(), если нужны будут дополнительные — пишите в поддержку.

count по умолчанию: 1000
Ограничение на максимальное количество постов, чтобы не перегрузить сервер. Если у вас больше 1000, вы можете увеличить это значение

cat по умолчанию: пусто
Через запятую можно указать id нужных рубрик для вывода постов и со знаком минус для скрытия, например: cat=”4,7,-8″

category_name по умолчанию: пусто
Через запятую можно указать ярлыки (slug) рубрик для вывода постов, например: category_name=”seo,ogorod”

tag по умолчанию: пусто
Через запятую можно задать ярлыки (slug) нужных меток для вывода постов с этими тегами, например: tag=”seo,design,ogorod”

author по умолчанию: пусто
Через запятую можно указать id нужных авторов, например: author=”1,3,-4″

post_type по умолчанию: post
Через запятую можно указать типы нужных постов. Для вывода терминов из произвольного типа постов “Глоссарий” можно указать значение post_type="glossary"

exclude по умолчанию: пусто
Через запятую можно указать id нужных постов для скрытия

include по умолчанию: пусто
Через запятую можно указать id нужных постов для вывода

tax_query по умолчанию: пусто
Выборка из таксономий, аналог tax_query в WP_Query. Состоит из 3 значений, указанных через &. Например: taxonomy=people&field=slug&terms=bob

post_parent по умолчанию: пусто
ID родительской страницы, дочерние страницы для которой надо получить

С версии плагина 1.3.0 добавлены следующие атрибуты шорткода:

taxonomy по умолчанию: пусто
Можно указать ярлык нужной таксономии (в т.ч. произвольной) для вывода всех её терминов

category__and по умолчанию: пусто
Через запятую можно указать id нужных рубрик и получить посты, которые входят одновременно в несколько категорий

category__in по умолчанию: пусто
Через запятую можно указать id нужных рубрик и получить посты, которые входят в одну из указанных категорий

category__not_in по умолчанию: пусто
Через запятую можно указать id нужных рубрик и получить посты, которые не входят в указанные категории

tag__and по умолчанию: пусто
Через запятую можно указать id нужных меток и получить посты одновременно из нескольких меток

tag__in по умолчанию: пусто
Через запятую можно указать id нужных меток и получить посты из хотя бы одной указанной метки

tag__not_in по умолчанию: пусто
Через запятую можно указать id нужных меток и получить посты, не относящиеся к указанным меткам

tag_slug__and по умолчанию: пусто
Через запятую можно задать ярлыки (slug) нужных меток и получить посты одновременно из нескольких меток

tag_slug__in по умолчанию: пусто
Через запятую можно задать ярлыки (slug) нужных меток и получить посты из хотя бы одной указанной метки

author__in по умолчанию: пусто
Через запятую можно указать id нужных авторов и получить посты хотя бы одного автора

author__not_in по умолчанию: пусто
Через запятую можно указать id нужных авторов, записи которых нужно исключить

post_parent__in по умолчанию: пусто
Выберет посты родители которых указаны в массиве

post_parent__not_in по умолчанию: пусто
Выберет посты родители которых не указаны в массиве

post__in по умолчанию: пусто
Через запятую можно указать id нужных записей, которые нужно вывести

post__not_in по умолчанию: пусто
Через запятую можно указать id нужных записей, которые нужно исключить

post_name__in по умолчанию: пусто
Через запятую можно указать ярлыки (slug) нужных записей, которые нужно вывести

post_status по умолчанию: ‘publish’
Можно вывести все записи по заданному статусу

Атрибуты для фильтрации таксономий:

exclude_tree по умолчанию: пусто
Через запятую можно указать id родительских терминов, которые нужно исключить. Исключена будет вся ветка.

hide_empty по умолчанию: true
Можно указать, скрывать ли термины в которых нет записей. 1(true) – скрывать пустые, 0(false) – показывать пустые.

child_of по умолчанию: 0
Можно указать id родительского термина. Вывести элементы таксономии, которые являются дочерними разделами указанного элемента. Будут получены все уровни вложенности, все дерево. Если указаны несколько таксономий, параметр будет проигнорирован.

parent по умолчанию: пусто
Можно указать id родительского термина, чтобы получить только прямых потомков. Будет получен только первый уровень вложенности, а не все дерево как в параметре child_of. Если указать 0, то будут выведены термины верхнего уровня.

Настройки > Список букв

show_letters по умолчанию: зависит от настроек плагина
Показать список букв

show_counts по умолчанию: зависит от настроек плагина
Показать количество постов для каждой буквы

show_search (с версии 1.2.0) по умолчанию: 0.
Включить поиск в алфавитном указателе. Поиск происходит по заголовкам постов.

alphabet (с версии 1.1.0) по умолчанию: пустая строка.
Если значение указано, задает порядок сортировки букв в списке, например, “абв 123”. Также буквы (и посты, названия которых начинаются на такие буквы), которые не включены в алфавит, не будут выводится. Поменять это поведение можно с помощью хука abc_pagination/functions/strict_match_alphabet

Настройки > Список постов

type по умолчанию: list
Тип вывода постов. Возможные значения: list, tabs или popup

show_tab_letter по умолчанию: 1
Показать букву в списке постов. Возможные значения: 0 или 1

show_post_link по умолчанию: 1
Включить ссылки на посты. Возможные значения: 0 или 1

show_post_thumb по умолчанию: 1
Показать миниатюры постов. Возможные значения: 0 или 1

show_post_excerpt по умолчанию: 0
Показать описание постов. Возможные значения: 0 или 1.

show_post_content по умолчанию: 0
Показать контент постов. Возможные значения: 0 или 1.

posts_short_title по умолчанию: 1
Использовать короткое название вместо заголовка. У каждой записи есть мета-поле, в котором можно задать короткое название для сортировки и вывода в алфавитном указателе. Если вы задали короткое название, то оно же будет использоваться для вывода на сайте. Если передать в этом атрибуте 0, то для вывода будет использоваться просто заголовок записи.

show_posts_limit (с версии 1.2.0) по умолчанию: -1
Позволяет ограничить вывод постов у каждой буквы указанным количеством и в случае превышения этого количества будет выводиться ссылка “показать еще”. Значение -1 убирает ограничение.

Внешний вид > Список букв

Почти все атрибуты ниже совпадают с CSS-свойствами (подробнее про свойства). Не забудьте указать единицы измерения.

Контейнер с буквами

letters_text_before (с версии 1.1.0) по умолчанию: пустая строка.
Текст для вывода перед буквами.

letters_text_after (с версии 1.1.0) по умолчанию: пустая строка.
Текст для вывода после букв

letters_gap по умолчанию: .5em (из настроек плагина)
Расстояние между буквами

letters_padding по умолчанию: .5em (из настроек плагина)
Внутренний отступ

letters_background по умолчанию: #eaeff6 (из настроек плагина)
Фоновый цвет блока

letters_justify_content по умолчанию: center (из настроек плагина)
Выравнивание букв, например: start, center, end, space-evenly, space-around, space-between

letters_border_radius по умолчанию: .5em (из настроек плагина)
Скругление у блока

Буквы

letter_padding по умолчанию: .3em .6em (из настроек плагина)
Внутренний отступ

letter_color по умолчанию: #ffffff (из настроек плагина)
Цвет букв (про цвета CSS)

letter_background по умолчанию: #74B423 (из настроек плагина)
Фон букв (про цвета CSS)

letter_hover_color (с версии 1.1.0) по умолчанию: #ffffff.
Цвет при наведении на букву.

letter_hover_background (с версии 1.1.0) по умолчанию: #5e9617.
Цвет фона при наведении на букву

letter_hover_effect (с версии 1.1.0) по умолчанию: пустая строка.
Возможные значения grow, shrink, push, pop, float

letter_border_width (с версии 1.1.0) по умолчанию: пустая строка.
Ширина рамки. Можно задавать значения с единицами измерения css, например 2px или 0.5em

letter_border_style (с версии 1.1.0) по умолчанию: solid
Стиль рами, возможные значения solid, dotted, dashed, double

letter_border_color (с версии 1.1.0) по умолчанию: пустая строка.
Цвет рамки.

letter_font_weight по умолчанию: bold (из настроек плагина)
Толщина шрифта

letter_font_size по умолчанию: 1em (из настроек плагина)
Размер шрифта

letter_border_radius по умолчанию: .3em (из настроек плагина)
Скругление углов

Внешний вид > Список постов

Буквы

tab_letter_width по умолчанию: auto (из настроек плагина)
Ширина буквы в списке постов, по умолчанию растягивается на всю ширину

tab_letter_margin по умолчанию: 1.5em 0 .5em (из настроек плагина)
Внешние отступы у буквы

tab_letter_padding по умолчанию: .3em 1em (из настроек плагина)
Внутренние отступы

tab_letter_font_weight по умолчанию: bold (из настроек плагина)
Толщина шрифта

tab_letter_font_size по умолчанию: 1.3em (из настроек плагина)
Размер шрифта

tab_letter_text_align по умолчанию: left (из настроек плагина)
Выравнивание текста, например: left, center, right

tab_letter_color по умолчанию: #111 (из настроек плагина)
Цвет буквы (про цвета CSS)

tab_letter_background по умолчанию: #eaeff6 (из настроек плагина)
Фон буквы (про цвета CSS)

tab_letter_border_radius по умолчанию: .2em (из настроек плагина)
Скругление углов

Посты

posts_image_height по умолчанию: 200px (из настроек плагина)
Высота миниатюр постов

posts_columns по умолчанию: 3 (из настроек плагина)
Колонки в десктопной версии

posts_columns_mobile по умолчанию: 1 (из настроек плагина)
Колонки в мобильной версии

posts_gap по умолчанию: .8em
Отступы между колонками

posts_title_font_weight с версии (1.1.0) по умолчанию:400
Толщина шрифта заголовка поста

posts_show_id с версии (1.2.0) по умолчанию: 0
Добавляет атрибут id у блоков с постами, который затем можно использовать в адресной строке браузера, например your-site.com/glossary/#termin-1

Атрибут name

Дополнительно можно указать атрибут name, чтобы задать дополнительный класс для блока .abc-pagination. Кроме класса этот атрибут может использоваться для определения, какой именно шорткод вызывается в хуке abc_pagination/get_posts/args.

Асинхронная подгрузука алфавитного указателя

ajax (с версии 1.2.0) по умолчанию 0. Если указать этот параметр, то указатель будет загружаться скриптом отдельно после отрисовки страницы.