WordPress.org

Ready to get started?Download WordPress

Codex

Attention Interested in functions, hooks, classes, or methods? Check out the new WordPress Code Reference!

User:Stevish/standardize parameters lists

Wow, this is really really tedious... I had to take a break, and I doubt if I'll ever get back to it.

This article is a ROUGH DRAFT. The author is still working on this document, so please do not edit this without the author's permission. The content within this article may not yet be verified or valid. This information is subject to change.

wp_list_bookmarks

Parameters

categorize
(boolean) (optional) Bookmarks should be shown within their assigned Categories (TRUE) or not (FALSE).
  • 1 (True - default)
  • 0 (False)
Default: True
category
(string) (optional) Comma separated list of numeric Category IDs to be displayed. If none is specified, all Categories with bookmarks are shown.
Default: '' (all Categories)
category_name
(string) (optional) The name of a Category whose bookmarks will be displayed. If none is specified, all Categories with bookmarks are shown.
Default: '' (all Categories)
category_before
(string) (optional) Text to put before each category.
Default: '<li id="$category_id" class="linkcat">'
category_after
(string) (optional) Text to put after each category.
Default: '</li>'
class
(string) (optional) The class each cateogory li will have on it.
Default: 'linkcat'
category_orderby
(string) (optional) Value to sort Categories on. Valid options:
  • 'name' (Default)
  • 'id'
Default: 'name'
category_order
(string) (optional) Sort order, ascending or descending for the category_orderby parameter. Valid values:
  • ASC (Default)
  • DESC
Default: 'ASC'


title_li 
(string) Text for the heading of the links list. Defaults to '__('Bookmarks')', which displays "Bookmarks" (the __('') is used for localization purposes). Only used with categorize set to 0 (else the category names will be used instead). If passed a null (0) value, no heading is displayed, and the list will not be wrapped with <ul>, </ul> tags.
title_before 
(string) Text to place before each Category description if 'categorize' is TRUE. Defaults to '<h2>'.
title_after 
(string) Text to place after each Category description if 'categorize' is TRUE. Defaults to '</h2>'.
show_private 
(boolean) Should a Category be displayed even if the Category is considered private. Ignore the admin setting and show private Categories (TRUE) or do NOT show private Categories (FALSE). Defaults to FALSE.
  • 1 (True)
  • 0 (False - default)
include 
(string) Comma separated list of numeric bookmark IDs to include in the output. For example, 'include=1,3,6' means to return or echo bookmark IDs 1, 3, and 6. If the include string is used, the category, category_name, and exclude parameters are ignored. Defaults to (all Bookmarks).
exclude 
(string) Comma separated list of numeric bookmark IDs to exclude. For example, 'exclude=4,12' means that bookmark IDs 4 and 12 will NOT be returned or echoed. Defaults to (exclude nothing).
orderby 
(string) Value to sort bookmarks on. Defaults to 'name' unless you pass the value of '' (empty), in which case it sets to 'id'. Valid options:
  • 'id'
  • 'url'
  • 'name'
  • 'target'
  • 'description'
  • 'owner' - User who added bookmark through bookmarks Manager.
  • 'rating'
  • 'updated'
  • 'rel' - bookmark relationship (XFN).
  • 'notes'
  • 'rss'
  • 'length' - The length of the bookmark name, shortest to longest.
  • 'rand' - Display bookmarks in random order.
order 
(string) Sort order, ascending or descending for the orderby parameter. Valid values:
  • ASC (Default)
  • DESC
limit 
(integer) Maximum number of bookmarks to display. Defaults to -1 (all bookmarks).
before 
(string) Text to place before each bookmark. Defaults to '<li>'.
after 
(string) Text to place after each bookmark. Defaults to '</li>'.
category_before 
(string) Text to place before each category. Defaults to '<li>' with an appropriate id and class.
category_after 
(string) Text to place after each category. Defaults to '</li>'.
between 
(string) Text to place between each bookmark/image and its description. Defaults to '\n' (newline).
show_images 
(boolean) Should images for bookmarks be shown (TRUE) or not (FALSE). Defaults to TRUE.
  • 1 (True - default)
  • 0 (False)
show_description 
(boolean) Should the description be displayed (TRUE) or not (FALSE). Valid when show_images is FALSE, or an image is not defined. Defaults to FALSE.
  • 1 (True)
  • 0 (False - default)
show_rating 
(boolean) Should rating stars/characters be displayed (TRUE) or not (FALSE). Defaults to FALSE.
  • 1 (True)
  • 0 (False - default)
show_updated 
(boolean) Should the last updated timestamp be displayed (TRUE) or not (FALSE). Defaults to FALSE.
  • 1 (True)
  • 0 (False - default)
hide_invisible 
(boolean) Should bookmark be displayed even if it's Visible setting is No. Abides by admin setting (TRUE) or does no abide by admin setting (FALSE). Defaults to TRUE.
  • 1 (True - default)
  • 0 (False)
echo 
(boolean) Display bookmarks (TRUE) or return them for use by PHP (FALSE). Defaults to TRUE.
  • 1 (True - default)
  • 0 (False)