get_archives_link() │ WP 1.0.0

Отримує посилання на архівну сторінку. Збирає посилання із переданих: УРЛ, анкор посилання, формат виводу, текст до та після.

Це допоміжна функція, яка збирає HTML тег посилання, у вказаному у параметрі $format форматі:

Текст обробляється фільтрами: wptexturize() і esc_attr() , а посилання esc_url() і в результаті ми отримаємо очищений текст, навіть якщо у функцію передати некоректні символи.

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

Повертає

Строку. HTML тег А.

Використання

get_archives_link( $url, $text, $format, $before, $after );
$url
(рядок) (обов’язковий)
Посилання URL:
http://example.com/2013.
$text
(рядок) (обов’язковий)
Анкор посилання (опис посилання, текст який буде показаний як посилання).
$format
(рядок)

У якому форматі виводитимемо посилання:

  • html– для використання у списках: ul або ol;
  • link– для використання у head частини HTML коду;
  • option– для використання в елементах форми select;
  • custom– інший формат, залиште це поле порожнім та використовуйте параметри before та after.

Типово: html

$before
(рядок)
Текст до посилання можна вказати HTML код.


За замовчуванням: ”
$after
(рядок)
Текст після посилання можна вказувати HTML код.


За замовчуванням: ”

Приклади

0

#1 Приклади показують, що повертає функція:

echo get_archives_link( '/2013', 'Архів за 2013 рік');
// поверне: <li><a href='/2013' title='Архів за 2013 рік'>Архів за 2013 рік</a></li>

get_archives_link( '/2013', 'Архів за 2013 рік', 'link' );
// <link rel='archives' title='Архів за 2013 рік' href='/2013' />

get_archives_link( '/2013', 'Архів за 2013 рік', 'option' );
// <option value='/2013'> Архів за 2013 рік</option>

get_archives_link( '/2013', 'Архів за 2013 рік', '', '<div>','</div>' );
// <div><a href='/2013' title='Архів за 2013 рік'>Архів за 2013 рік</a></div>

список змін

З версії 1.0.0Введено.
З версії 5.2.0Added the $selected parameter.

get archives link WP 6.0.2

wp-includes/general-template.php 
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>$aftern";
	}

	/**
	 * Filters the archive link content.
	 *
	 * @ Since 2.6.0
	 * @since 4.5.0 Added `$url`, `$text`, `$format`, `$before`, і `$after` parameters.
	 * @since 5.2.0 Added `$selected` parameter.
	 *
	 * @param string $link_html The archive HTML link content.
	 * @param string $url URL для архіву.
	 * @param string $text Archive text description.
	 * @param string $format Link format. Can be 'link', 'option', 'html', або 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 );
}

Основні

Залишити відповідь

Ваша e-mail адреса не оприлюднюватиметься. Обов’язкові поля позначені *