get_archives_link() — описание функции WordPress на русском

Сигнатура

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

Описание

Формат может быть одним из четырёх стилей. ‘link’ — для элемента head, ‘option’ — для использования в элементе select, ‘html’ — для использования в списке (HTML-элементы ol или ul). Также поддерживается произвольное содержимое с помощью параметров before и after.
Формат ‘link’ использует HTML-элемент с отношением archives. Параметры before и after не используются. Параметр text используется для описания ссылки.
Формат ‘option’ использует HTML-элемент option для использования в элементе select.
Значением служит параметр url, а параметры before и after используются вокруг текстового описания.
Формат ‘html’, используемый по умолчанию, использует HTML-элемент li для использования в HTML-элементах списка. Параметр before идёт перед ссылкой, а параметр after — после закрывающего тега ссылки.
Произвольный формат использует параметр before перед ссылкой (HTML-элемент ‘a’) и параметр after после закрывающего тега ссылки. Если не используется ни одно из трёх приведённых выше значений формата, предполагается произвольный формат.

Оригинал (английский)

The format can be one of four styles. The ‘link’ for head element, ‘option’ for use in the select element, ‘html’ for use in list (either ol or ul HTML elements). Custom content is also supported using the before and after parameters.

The ‘link’ format uses the <link> HTML element with the archives relationship. The before and after parameters are not used. The text parameter is used to describe the link.

The ‘option’ format uses the option HTML element for use in select element.
The value is the url parameter and the before and after parameters are used between the text description.

The ‘html’ format, which is the default, uses the li HTML element for use in the list HTML elements. The before parameter is before the link and the after parameter is after the closing link.

The custom format uses the before parameter before the link (‘a’ HTML element) and the after parameter after the closing link tag. If the above three values for the format are not used, then custom format is assumed.

Параметры

$url string обязательный

URL архива.

$text string обязательный

Текстовое описание архива.

$format string необязательный = 'html'

Может быть 'link', 'option', 'html' или произвольным. Значение по умолчанию 'html'.

$before string необязательный = ''

Содержимое, добавляемое перед описанием.

$after string необязательный = ''

Содержимое, добавляемое после описания.

$selected bool необязательный = false

Устанавливается в true, если текущая страница является выбранной страницей архива.

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

string

Исходный код

wp-includes/general-template.php:1928

function get_archives_link( $url, $text, $format = 'html', $before = '', $after = '', $selected = false ) {
	$text         = wptexturize( $text );
	$url          = esc_url( $url );
	$aria_current = $selected ? ' aria-current="page"' : '';

	if ( 'link' === $format ) {
		$link_html = "\t<link rel='archives' title='" . esc_attr( $text ) . "' href='$url' />\n";
	} elseif ( 'option' === $format ) {
		$selected_attr = $selected ? " selected='selected'" : '';
		$link_html     = "\t<option value='$url'$selected_attr>$before $text $after</option>\n";
	} elseif ( 'html' === $format ) {
		$link_html = "\t<li>$before<a href='$url'$aria_current>$text</a>$after</li>\n";
	} else { // Custom.
		$link_html = "\t$before<a href='$url'$aria_current>$text</a>$after\n";
	}

	/**
	 * Filters the archive link content.
	 *
	 * @since 2.6.0
	 * @since 4.5.0 Added the `$url`, `$text`, `$format`, `$before`, and `$after` parameters.
	 * @since 5.2.0 Added the `$selected` parameter.
	 *
	 * @param string $link_html The archive HTML link content.
	 * @param string $url       URL to archive.
	 * @param string $text      Archive text description.
	 * @param string $format    Link format. Can be 'link', 'option', 'html', or custom.
	 * @param string $before    Content to prepend to the description.
	 * @param string $after     Content to append to the description.
	 * @param bool   $selected  True if the current page is the selected archive.
	 */
	return apply_filters( 'get_archives_link', $link_html, $url, $text, $format, $before, $after, $selected );
}

История изменений

Версия	Описание
5.2.0	Added the $selected parameter.
1.0.0	Introduced.