Функция get_archives_link() в WordPress

Функция get_archives_link() позволяет получать ссылки на архивы, используя предопределенный или пользовательский код. С помощью этой функции можно создавать ссылки в различных форматах, таких как ссылка в заголовке, опция для выпадающего списка или HTML-элемент для списков.

Форматы вывода

Существует четыре возможных формата для вывода:

• link: используется для HTML-элемента <link>, который добавляется в заголовок страницы.
• option: используется для HTML-элемента <option> в выпадающем списке.
• html: используется для HTML-элемента <li>, который подходит для списков (<ul> или <ol>).
• custom: позволяет использовать собственные элементы HTML.

Параметры функции

Сигнатура функции:

string get_archives_link( string $url, string $text, string $format = 'html', string $before = '', string $after = '', bool $selected = false )

Параметры:

• $url (string) (обязательно): URL-адрес архива.
• $text (string) (обязательно): текст описания архива.
• $format (string): формат ссылки. Может принимать значения 'link', 'option', 'html' или custom. По умолчанию: 'html'.
• $before (string): содержимое, добавляемое перед описанием. По умолчанию: пустая строка.
• $after (string): содержимое, добавляемое после описания. По умолчанию: пустая строка.
• $selected (bool): установите true, если текущая страница является выбранной архивной страницей. По умолчанию: false.

Использование функции

Функцию get_archives_link можно использовать следующим образом:

echo get_archives_link( '/2013', 'Архив 2013' );
// Вывод: 
Архив 2013

get_archives_link( '/2013', 'Архив 2013', 'link' );
// Вывод: 

get_archives_link( '/2013', 'Архив 2013', 'option' );
// Вывод: Архив 2013

get_archives_link( '/2013', 'Архив 2013', '', '
', '
' );
// Вывод: 
Архив 2013

Пример модификации ссылки

Если вы хотите добавить HTML-элемент <span> вокруг числа постов в виджете архива, это можно сделать с помощью фильтра:

add_filter( 'get_archives_link', 'wpdocs_archive_count_span' );

/**
 * Добавляет  вокруг числа постов в виджете архива.
 *
 * @param   string  $links  Поля комментариев.
 * @return  string
 */
function wpdocs_archive_count_span( $links ) {
    $links = str_replace( ' (', '', $links );
    $links = str_replace( ')', '', $links );

    return $links;
}

Возвращаемое значение

Функция возвращает строку — HTML-код для ссылки на архив.

Изменения в версии

• С 1.0.0: Функция была введена.
• С 5.2.0: Добавлен параметр $selected.

Теперь вы знаете, как использовать функцию get_archives_link() в WordPress для создания ссылок на архивы. Эта функция предоставляет гибкость в настройках и позволяет легко настроить отображение архивов на вашем сайте.