• Skip to primary navigation
  • Skip to main content
  • Skip to primary sidebar
  • Skip to footer
WordPress core a2z

WordPress core a2z

WordPress core only

  • Home
  • Plugins
  • Blocks
  • Shortcodes
  • APIs
  • Classes
  • Files
  • Hooks
  • Sitemap
  • Blog
Home / APIs / get_archives_link() – Retrieve archive link content based on predefined or custom code.

You appear to be a bot. Output may be restricted

Description

Retrieve archive link content based on predefined or custom code.

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.

Usage

$string = get_archives_link( $url, $text, $format, $before, $after, $selected );

Parameters

$url
( string ) required – URL to archive.
$text
( string ) required – Archive text description.
$format
( string ) optional default: html – Optional. Can be 'link', 'option', 'html', or custom. Default 'html'.
$before
( string ) optional – Optional. Content to prepend to the description. Default empty.
$after
( string ) optional – Optional. Content to append to the description. Default empty.
$selected
( bool ) optional – Optional. Set to true if the current page is the selected archive page.

Returns

string HTML link content for archive.

Source

File name: wordpress/wp-includes/general-template.php
Lines:

1 to 33 of 33
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 );
}
 

 View on GitHub View on Trac

Published: 25th November 2019 | Last updated: 2nd April 2020

Primary Sidebar

Information

Function name: get_archives_link
Plugin ref: WordPress
Version: 5.6
Sourcefile: wp-includes/general-template.php
File ref: wp-includes/general-template.php
Deprecated?: No
API Letters: A,G,L

Footer

WP-a2z
WordPress core a2z
WordPress core only
WordPress 5.6
WordPress a2z
WordPress core a2z
Genesis Theme Framework a2z
Jetpack a2z
WordPress develop tests
Easy Digital Downloads a2z
WooCommerce a2z
Yoast SEO a2z
WordPress Blocks

Site:  core.wp-a2z.org
© Copyright WP-a2z 2014-2021. All rights reserved.


Website designed and developed by Herb Miller
Proudly powered by WordPress and oik plugins

  • Home
  • Blog
  • Sitemap
  • Sites