X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/177fd6fefd2e3d5a0ea6591c71d660cabdb3c1a4..refs/tags/wordpress-2.6.2:/wp-includes/bookmark-template.php diff --git a/wp-includes/bookmark-template.php b/wp-includes/bookmark-template.php index 50326bcd..e687e562 100644 --- a/wp-includes/bookmark-template.php +++ b/wp-includes/bookmark-template.php @@ -7,24 +7,31 @@ */ /** - * _walk_bookmarks() - The formatted output of a list of bookmarks + * 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. + * 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. + * This function is used internally by wp_list_bookmarks() and should not be + * used by themes. * * The defaults for overwriting are: - * 'show_updated' - Default is 0 (integer). Will show the time of when the bookmark was last updated. - * 'show_description' - Default is 0 (integer). Whether to show the description of the bookmark. - * 'show_images' - Default is 1 (integer). Whether to show link image if available. - * 'before' - Default is '
  • ' (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_updated' - Default is 0 (integer). Will show the time of when the + * bookmark was last updated. + * 'show_description' - Default is 0 (integer). Whether to show the description + * of the bookmark. + * 'show_images' - Default is 1 (integer). Whether to show link image if + * available. + * 'before' - Default is '
  • ' (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 @@ -69,7 +76,7 @@ function _walk_bookmarks($bookmarks, $args = '' ) { if ( $show_updated ) if ( '00' != substr($bookmark->link_updated_f, 0, 2) ) { - $title .= ' '; + $title .= ' ('; $title .= sprintf(__('Last updated: %s'), date(get_option('links_updated_date_format'), $bookmark->link_updated_f + (get_option('gmt_offset') * 3600))); $title .= ')'; } @@ -113,49 +120,73 @@ function _walk_bookmarks($bookmarks, $args = '' ) { } /** - * wp_list_bookmarks() - Retrieve or echo all of the 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. + * '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 '

    ' (string). The HTML or text to show before the 'title_li' string. - * 'title_after' - Default is '

    ' (string). The HTML or text to show after the 'title_li' string. - * 'class' - Default is 'linkcat' (string). The CSS class to use for the 'title_li'. + * 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 '

    ' (string). The HTML or text to show before + * the 'title_li' string. + * 'title_after' - Default is '

    ' (string). The HTML or text to show after + * the 'title_li' string. + * 'class' - Default is 'linkcat' (string). The CSS class to use for the + * 'title_li'. * - * 'category_before' - Default is '
  • '. String must contain '%id' and '%class' to get - * the id of the category and the 'class' argument. These are used for formatting in themes. Argument will be displayed - * before the 'title_before' argument. - * 'category_after' - Default is '
    • ' (string). The HTML or text that will appear after the list of links. + * 'category_before' - Default is '
  • '. String must + * contain '%id' and '%class' to get + * the id of the category and the 'class' argument. These are used for + * formatting in themes. + * Argument will be displayed before the 'title_before' argument. + * 'category_after' - Default is '
    • ' (string). The HTML or text that will + * appear after the list of links. * * These are only used if 'categorize' is set to 1 or true. - * 'category_orderby' - Default is 'name'. How to order the bookmark category based on term scheme. - * 'category_order' - Default is 'ASC'. Set the order by either ASC (ascending) or DESC (descending). + * 'category_orderby' - Default is 'name'. How to order the bookmark category + * based on term scheme. + * 'category_order' - Default is 'ASC'. Set the order by either ASC (ascending) + * or DESC (descending). * - * @see _walk_bookmarks() For other arguments that can be set in this function and passed to _walk_bookmarks(). - * @see get_bookmarks() For other arguments that can be set in this function and passed to get_bookmarks(). + * @see _walk_bookmarks() For other arguments that can be set in this function + * and passed to _walk_bookmarks(). + * @see get_bookmarks() For other arguments that can be set in this function and + * passed to get_bookmarks(). + * @link http://codex.wordpress.org/Template_Tags/wp_list_bookmarks * * @since 2.1 - * @uses _list_bookmarks() Used to iterate over all of the bookmarks and return the html + * @uses _list_bookmarks() Used to iterate over all of the bookmarks and return + * the html * @uses get_terms() Gets all of the categories that are for links. * * @param string|array $args Optional. Overwrite the defaults of the function - * @return string|null Will only return if echo option is set to not echo. Default is not return anything. + * @return string|null Will only return if echo option is set to not echo. + * Default is not return anything. */ function wp_list_bookmarks($args = '') { $defaults = array( 'orderby' => 'name', 'order' => 'ASC', - 'limit' => -1, 'category' => '', + 'limit' => -1, 'category' => '', 'exclude_category' => '', 'category_name' => '', 'hide_invisible' => 1, 'show_updated' => 0, 'echo' => 1, 'categorize' => 1, 'title_li' => __('Bookmarks'), @@ -172,7 +203,7 @@ function wp_list_bookmarks($args = '') { if ( $categorize ) { //Split the bookmarks into ul's for each category - $cats = get_terms('link_category', "category_name=$category_name&include=$category&orderby=$category_orderby&order=$category_order&hierarchical=0"); + $cats = get_terms('link_category', array('name__like' => $category_name, 'include' => $category, 'exclude' => $exclude_category, 'orderby' => $category_orderby, 'order' => $category_order, 'hierarchical' => 0)); foreach ( (array) $cats as $cat ) { $params = array_merge($r, array('category'=>$cat->term_id)); @@ -181,7 +212,7 @@ function wp_list_bookmarks($args = '') { continue; $output .= str_replace(array('%id', '%class'), array("linkcat-$cat->term_id", $class), $category_before); $catname = apply_filters( "link_category", $cat->name ); - $output .= "$title_before$catname$title_after\n\t