get_archives_link

SummerySummery

Retrieve archive link content based on predefined or custom code.

Syntax

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

DescriptionDescription

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.

ParametersParameters

$url

(string) (Required) URL to archive.

$text

(string) (Required) Archive text description.

$format

(string) (Optional) Can be 'link', 'option', 'html', or custom.

Default value: 'html'

$before

(string) (Optional) Content to prepend to the description.

Default value: ''

$after

(string) (Optional) Content to append to the description.

Default value: ''

$selected

(bool) (Optional) Set to true if the current page is the selected archive page.

Default value: false

ReturnReturn

(string) HTML link content for archive.

SourceSource

File: wp-includes/general-template.php


			

ChangelogChangelog

Changelog
Version Description
5.2.0 Added the $selected parameter.
1.0.0 Introduced.
Scroll to Top