[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

/wp-includes/ -> bookmark-template.php (summary)

Bookmark Template Functions for usage in Themes.

File Size: 336 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 2 functions

  _walk_bookmarks()
  wp_list_bookmarks()

Functions
Functions that are not part of a class:

_walk_bookmarks( $bookmarks, $args = '' )   X-Ref
The formatted output of a list of bookmarks.

The $bookmarks array must contain bookmark objects and will be iterated over
to retrieve the bookmark to be used in the output.

The output is formatted as HTML with no way to change that format. However,
what is between, before, and after can be changed. The link itself will be
HTML.

This function is used internally by wp_list_bookmarks() and should not be
used by themes.

param: array        $bookmarks List of bookmarks to traverse.
param: string|array $args {
return: string Formatted output in HTML

wp_list_bookmarks( $args = '' )   X-Ref
Retrieves or echoes all of the bookmarks.

List of default arguments are as follows:

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.

param: string|array $args {
return: void|string Void if 'echo' argument is true, HTML list of bookmarks if 'echo' is false.



Generated : Mon Mar 18 08:20:01 2024 Cross-referenced by PHPXref