Function Reference/get links list

This page redirects to an external site: https://developer.wordpress.org/reference/functions/get_links_list/

Languages: English • 日本語 (Add your language)

This function has been deprecated. That means it has been replaced by a new function or is no longer supported, and may be removed from future versions. All code that uses this function should be converted to use its replacement if one exists. See also wp-includes/deprecated.php. Use any of these functions instead.

1 Description
2 Replace With
3 Usage
4 Example
5 Parameters
6 Related

Description

Displays a nested HTML unordered list of all links as defined in the Links Manager, sorted under Link Category headings. Note: the Link Category headings are automatically generated inside of <h2> headings.

Note: This tag does not respect the "Before Link", "Between Link and Description", and "After Link" settings defined for Link Categories in the Links Manager, Formatting (but respect Category Options, Show, Description). To get around this feature/limitation, see Example 2 from wp_get_links().

Replace With

wp_list_bookmarks().

Usage

<?php get_links_list('order'); ?>

Example

Display links sorted by Link Category ID.

<?php get_links_list('id'); ?>

Automatically generates the <li> with an ID of the Link Category wrapped in an <h2> heading. It looks like this (links edited for space):

<li id="linkcat-1"><h2>Blogroll</h2>
   <ul>
      <li><a href="http://example1.com/">Blogroll Link 1</a></li>
      <li><a href="http://example2.com/">Blogroll Link 2</a></li>
      <li><a href="http://example3.com/">Blogroll Link 3</a></li>
    </ul>
</li>

Parameters

order

(string) Value to sort Link Categories by. Valid values:

'name' (Default)
'id'

Prefixing the above options with an underscore (ex: '_id') sorts links in reverse order.

get_bookmark(), get_bookmark_field(), get_bookmarks(), wp_list_bookmarks()

See also index of Function Reference and index of Template Tags.

Codex