Make WordPress Core


Ignore:
Timestamp:
05/25/2008 03:45:05 PM (14 years ago)
Author:
ryan
Message:

phpdoc updates from jacobsantos. see #7038

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/wp-includes/bookmark-template.php

    r7911 r7990  
    88
    99/**
    10  * _walk_bookmarks() - The formatted output of a list of bookmarks
     10 * The formatted output of a list of bookmarks
    1111 *
    1212 * The $bookmarks array must contain bookmark objects and will be iterated over
    1313 * to retrieve the bookmark to be used in the output.
    1414 *
    15  * The output is formatted as HTML with no way to change that format. However, what
    16  * is between, before, and after can be changed. The link itself will be HTML.
    17  *
    18  * This function is used internally by wp_list_bookmarks() and should not be used by
    19  * themes.
     15 * The output is formatted as HTML with no way to change that format. However,
     16 * what is between, before, and after can be changed. The link itself will be
     17 * HTML.
     18 *
     19 * This function is used internally by wp_list_bookmarks() and should not be
     20 * used by themes.
    2021 *
    2122 * The defaults for overwriting are:
    22  * 'show_updated' - Default is 0 (integer). Will show the time of when the bookmark was last updated.
    23  * 'show_description' - Default is 0 (integer). Whether to show the description of the bookmark.
    24  * 'show_images' - Default is 1 (integer). Whether to show link image if available.
    25  * 'before' - Default is '<li>' (string). The html or text to prepend to each bookmarks.
    26  * 'after' - Default is '</li>' (string). The html or text to append to each bookmarks.
    27  * 'between' - Default is '\n' (string). The string for use in between the link, description, and image.
     23 * 'show_updated' - Default is 0 (integer). Will show the time of when the
     24 *      bookmark was last updated.
     25 * 'show_description' - Default is 0 (integer). Whether to show the description
     26 *      of the bookmark.
     27 * 'show_images' - Default is 1 (integer). Whether to show link image if
     28 *      available.
     29 * 'before' - Default is '<li>' (string). The html or text to prepend to each
     30 *      bookmarks.
     31 * 'after' - Default is '</li>' (string). The html or text to append to each
     32 *      bookmarks.
     33 * 'between' - Default is '\n' (string). The string for use in between the link,
     34 *      description, and image.
    2835 * 'show_rating' - Default is 0 (integer). Whether to show the link rating.
    2936 *
     
    114121
    115122/**
    116  * wp_list_bookmarks() - Retrieve or echo all of the bookmarks
     123 * Retrieve or echo all of the bookmarks
    117124 *
    118125 * List of default arguments are as follows:
    119  * 'orderby' - Default is 'name' (string). How to order the links by. String is based off of the bookmark scheme.
    120  * 'order' - Default is 'ASC' (string). Either 'ASC' or 'DESC'. Orders in either ascending or descending order.
    121  * 'limit' - Default is -1 (integer) or show all. The amount of bookmarks to display.
    122  * 'category' - Default is empty string (string). Include the links in what category ID(s).
    123  * 'category_name' - Default is empty string (string). Get links by category name.
    124  * 'hide_invisible' - Default is 1 (integer). Whether to show (default) or hide links marked as 'invisible'.
    125  * 'show_updated' - Default is 0 (integer). Will show the time of when the bookmark was last updated.
    126  * 'echo' - Default is 1 (integer). Whether to echo (default) or return the formatted bookmarks.
    127  * 'categorize' - Default is 1 (integer). Whether to show links listed by category (default) or show links in one column.
    128  *
    129  * These options define how the Category name will appear before the category links are displayed, if 'categorize' is 1.
    130  * If 'categorize' is 0, then it will display for only the 'title_li' string and only if 'title_li' is not empty.
    131  * 'title_li' - Default is 'Bookmarks' (translatable string). What to show before the links appear.
    132  * 'title_before' - Default is '<h2>' (string). The HTML or text to show before the 'title_li' string.
    133  * 'title_after' - Default is '</h2>' (string). The HTML or text to show after the 'title_li' string.
    134  * 'class' - Default is 'linkcat' (string). The CSS class to use for the 'title_li'.
    135  *
    136  * 'category_before' - Default is '<li id="%id" class="%class">'. String must contain '%id' and '%class' to get
    137  * the id of the category and the 'class' argument. These are used for formatting in themes. Argument will be displayed
    138  * before the 'title_before' argument.
    139  * 'category_after' - Default is '</li>' (string). The HTML or text that will appear after the list of links.
     126 * 'orderby' - Default is 'name' (string). How to order the links by. String is
     127 *      based off of the bookmark scheme.
     128 * 'order' - Default is 'ASC' (string). Either 'ASC' or 'DESC'. Orders in either
     129 *      ascending or descending order.
     130 * 'limit' - Default is -1 (integer) or show all. The amount of bookmarks to
     131 *      display.
     132 * 'category' - Default is empty string (string). Include the links in what
     133 *      category ID(s).
     134 * 'category_name' - Default is empty string (string). Get links by category
     135 *      name.
     136 * 'hide_invisible' - Default is 1 (integer). Whether to show (default) or hide
     137 *      links marked as 'invisible'.
     138 * 'show_updated' - Default is 0 (integer). Will show the time of when the
     139 *      bookmark was last updated.
     140 * 'echo' - Default is 1 (integer). Whether to echo (default) or return the
     141 *      formatted bookmarks.
     142 * 'categorize' - Default is 1 (integer). Whether to show links listed by
     143 *      category (default) or show links in one column.
     144 *
     145 * These options define how the Category name will appear before the category
     146 * links are displayed, if 'categorize' is 1. If 'categorize' is 0, then it will
     147 * display for only the 'title_li' string and only if 'title_li' is not empty.
     148 * 'title_li' - Default is 'Bookmarks' (translatable string). What to show
     149 *      before the links appear.
     150 * 'title_before' - Default is '<h2>' (string). The HTML or text to show before
     151 *      the 'title_li' string.
     152 * 'title_after' - Default is '</h2>' (string). The HTML or text to show after
     153 *      the 'title_li' string.
     154 * 'class' - Default is 'linkcat' (string). The CSS class to use for the
     155 *      'title_li'.
     156 *
     157 * 'category_before' - Default is '<li id="%id" class="%class">'. String must
     158 *      contain '%id' and '%class' to get
     159 * the id of the category and the 'class' argument. These are used for
     160 *      formatting in themes.
     161 * Argument will be displayed before the 'title_before' argument.
     162 * 'category_after' - Default is '</li>' (string). The HTML or text that will
     163 *      appear after the list of links.
    140164 *
    141165 * These are only used if 'categorize' is set to 1 or true.
    142  * 'category_orderby' - Default is 'name'. How to order the bookmark category based on term scheme.
    143  * 'category_order' - Default is 'ASC'. Set the order by either ASC (ascending) or DESC (descending).
    144  *
    145  * @see _walk_bookmarks() For other arguments that can be set in this function and passed to _walk_bookmarks().
    146  * @see get_bookmarks() For other arguments that can be set in this function and passed to get_bookmarks().
     166 * 'category_orderby' - Default is 'name'. How to order the bookmark category
     167 *      based on term scheme.
     168 * 'category_order' - Default is 'ASC'. Set the order by either ASC (ascending)
     169 *      or DESC (descending).
     170 *
     171 * @see _walk_bookmarks() For other arguments that can be set in this function
     172 *      and passed to _walk_bookmarks().
     173 * @see get_bookmarks() For other arguments that can be set in this function and
     174 *      passed to get_bookmarks().
     175 * @link http://codex.wordpress.org/Template_Tags/wp_list_bookmarks
    147176 *
    148177 * @since 2.1
    149  * @uses _list_bookmarks() Used to iterate over all of the bookmarks and return the html
     178 * @uses _list_bookmarks() Used to iterate over all of the bookmarks and return
     179 *      the html
    150180 * @uses get_terms() Gets all of the categories that are for links.
    151181 *
    152182 * @param string|array $args Optional. Overwrite the defaults of the function
    153  * @return string|null Will only return if echo option is set to not echo. Default is not return anything.
     183 * @return string|null Will only return if echo option is set to not echo.
     184 *      Default is not return anything.
    154185 */
    155186function wp_list_bookmarks($args = '') {
Note: See TracChangeset for help on using the changeset viewer.