get_links_list

Output entire list of links by category.

Description

get_links_list( (string) $order = 'name' );

Output a list of all links, listed by category, using the settings in $wpdb->linkcategories and output it as a nested HTML unordered list.

Parameters (1)

0. $order — Optional. (string) => 'name': Sort link categories by name or id

Usage

if ( !function_exists( 'get_links_list' ) ) { 
    require_once ABSPATH . WPINC . '/deprecated.php'; 
} 
  
// Sort link categories by 'name' or 'id' 
$order = 'name'; 
  
// NOTICE! Understand what this does before running. 
$result = get_links_list($order);

Defined (1)

The function is defined in the following location(s).

/wp-includes/deprecated.php

function get_links_list($order = 'name') { 
    _deprecated_function( __FUNCTION__, '2.1.0', 'wp_list_bookmarks()' ); 
 
    $order = strtolower($order); 
 
    // Handle link category sorting 
    $direction = 'ASC'; 
    if ( '_' == substr($order, 0, 1) ) { 
        $direction = 'DESC'; 
        $order = substr($order, 1); 
    } 
 
    if ( !isset($direction) ) 
        $direction = ''; 
 
    $cats = get_categories(array('type' => 'link', 'orderby' => $order, 'order' => $direction, 'hierarchical' => 0)); 
 
    // Display each category 
    if ( $cats ) { 
        foreach ( (array) $cats as $cat ) { 
            // Handle each category. 
 
            // Display the category name 
            echo '  <li id="linkcat-' . $cat->term_id . '" class="linkcat"><h2>' . apply_filters('link_category', $cat->name ) . "</h2>\n\t<ul>\n"; 
            // Call get_links() with all the appropriate params 
            get_links($cat->term_id, '<li>', "</li>", "\n", true, 'name', false); 
 
            // Close the last category 
            echo "\n\t</ul>\n</li>\n"; 
        } 
    } 
}