diff --git a/wp-includes/bookmark-template.php b/wp-includes/bookmark-template.php index 70e495ce09..6e6a86a7d4 100644 --- a/wp-includes/bookmark-template.php +++ b/wp-includes/bookmark-template.php @@ -1,5 +1,40 @@ ' (string). The html or text to prepend to each bookmarks. + * 'after' - Default is '' (string). The html or text to append to each bookmarks. + * 'between' - Default is '\n' (string). The string for use in between the link, description, and image. + * 'show_rating' - Default is 0 (integer). Whether to show the link rating. + * + * @since 2.1 + * @access private + * @usedby wp_list_bookmarks() + * + * @param array $bookmarks List of bookmarks to traverse + * @param string|array $args Optional. Overwrite the defaults. + * @return string Formatted output in HTML + */ function _walk_bookmarks($bookmarks, $args = '' ) { $defaults = array( 'show_updated' => 0, 'show_description' => 0, @@ -77,6 +112,46 @@ function _walk_bookmarks($bookmarks, $args = '' ) { return $output; } +/** + * wp_list_bookmarks() - Retrieve or echo all of the bookmarks + * + * List of default arguments are as follows: + * 'orderby' - Default is 'name' (string). How to order the links by. String is based off of the bookmark scheme. + * 'order' - Default is 'ASC' (string). Either 'ASC' or 'DESC'. Orders in either ascending or descending order. + * 'limit' - Default is -1 (integer) or show all. The amount of bookmarks to display. + * 'category' - Default is empty string (string). Include the links in what category ID(s). + * 'category_name' - Default is empty string (string). Get links by category name. + * 'hide_invisible' - Default is 1 (integer). Whether to show (default) or hide links marked as 'invisible'. + * 'show_updated' - Default is 0 (integer). Will show the time of when the bookmark was last updated. + * 'echo' - Default is 1 (integer). Whether to echo (default) or return the formatted bookmarks. + * 'categorize' - Default is 1 (integer). Whether to show links listed by category (default) or show links in one column. + * + * These options define how the Category name will appear before the category links are displayed, if 'categorize' is 1. + * If 'categorize' is 0, then it will display for only the 'title_li' string and only if 'title_li' is not empty. + * 'title_li' - Default is 'Bookmarks' (translatable string). What to show before the links appear. + * 'title_before' - Default is '