<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[29108] trunk/src/wp-includes/bookmark-template.php: Convert default arguments documentation for `_walk_bookmarks()` and `wp_list_bookmarks()` into hash notations.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/29108">29108</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2014-07-11 22:53:09 +0000 (Fri, 11 Jul 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Convert default arguments documentation for `_walk_bookmarks()` and `wp_list_bookmarks()` into hash notations.
Props coffee2code for the initial patch.
See <a href="http://core.trac.wordpress.org/ticket/28841">#28841</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesbookmarktemplatephp">trunk/src/wp-includes/bookmark-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesbookmarktemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/bookmark-template.php (29107 => 29108)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/bookmark-template.php 2014-07-11 22:49:50 UTC (rev 29107)
+++ trunk/src/wp-includes/bookmark-template.php 2014-07-11 22:53:09 UTC (rev 29108)
</span><span class="lines">@@ -19,32 +19,33 @@
</span><span class="cx"> * This function is used internally by wp_list_bookmarks() and should not be
</span><span class="cx"> * used by themes.
</span><span class="cx"> *
</span><del>- * 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.
- * 'show_name' - Default is 0 (integer). Whether to show link name if
- * available.
- * 'before' - Default is '<li>' (string). The html or text to prepend to each
- * bookmarks.
- * 'after' - Default is '</li>' (string). The html or text to append to each
- * bookmarks.
- * 'link_before' - Default is '' (string). The html or text to prepend to each
- * bookmarks inside the <a> tag.
- * 'link_after' - Default is '' (string). The html or text to append to each
- * bookmarks inside the <a> tag.
- * '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.
- *
</del><span class="cx"> * @since 2.1.0
</span><span class="cx"> * @access private
</span><span class="cx"> *
</span><del>- * @param array $bookmarks List of bookmarks to traverse
- * @param string|array $args Optional. Overwrite the defaults.
</del><ins>+ * @param array $bookmarks List of bookmarks to traverse.
+ * @param string|array $args {
+ * Optional. Bookmarks arguments.
+ *
+ * @type int|bool $show_updated Whether to show the time the bookmark was last updated.
+ * Accepts 1|true or 0|false. Default 0|false.
+ * @type int|bool $show_description Whether to show the bookmakr description. Accepts 1|true,
+ * Accepts 1|true or 0|false. Default 0|false.
+ * @type int|bool $show_images Whether to show the link image if available. Accepts 1|true
+ * or 0|false. Default 1|true.
+ * @type int|bool $show_name Whether to show link name if available. Accepts 1|true or
+ * 0|false. Default 0|false.
+ * @type string $before The HTML or text to prepend to each bookmark. Default '<li>'.
+ * @type string $after The HTML or text to append to each bookmark. Default '</li>'.
+ * @type string $link_before The HTML or text to prepend to each bookmark inside the anchor
+ * tags. Default empty.
+ * @type string $link_after The HTML or text to append to each bookmark inside the anchor
+ * tags. Default empty.
+ * @type string $between The string for use in between the link, description, and image.
+ * Default "\n".
+ * @type int|bool $show_rating Whether to show the link rating. Accepts 1|true or 0|false.
+ * Default 0|false.
+ *
+ * }
</ins><span class="cx"> * @return string Formatted output in HTML
</span><span class="cx"> */
</span><span class="cx"> function _walk_bookmarks( $bookmarks, $args = '' ) {
</span><span class="lines">@@ -148,67 +149,53 @@
</span><span class="cx"> * Retrieve or echo all of the bookmarks.
</span><span class="cx"> *
</span><span class="cx"> * List of default arguments are as follows:
</span><del>- * '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.
- * 'show_description' - Default is 0 (integer). Whether to show the description
- * of the bookmark.
</del><span class="cx"> *
</span><span class="cx"> * These options define how the Category name will appear before the category
</span><span class="cx"> * links are displayed, if 'categorize' is 1. If 'categorize' is 0, then it will
</span><span class="cx"> * display for only the 'title_li' string and only if 'title_li' is not empty.
</span><del>- * 'title_li' - Default is 'Bookmarks' (translatable string). What to show
- * before the links appear.
- * 'title_before' - Default is '<h2>' (string). The HTML or text to show before
- * the 'title_li' string.
- * 'title_after' - Default is '</h2>' (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'.
</del><span class="cx"> *
</span><del>- * 'category_before' - Default is '<li id="%id" class="%class">'. 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 '</li>' (string). The HTML or text that will
- * appear after the list of links.
</del><ins>+ * @since 2.1.0
</ins><span class="cx"> *
</span><del>- * 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).
</del><ins>+ * @see _walk_bookmarks()
</ins><span class="cx"> *
</span><del>- * @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
</del><ins>+ * @param string|array $args {
+ * Optional. String or array of arguments to list bookmarks.
</ins><span class="cx"> *
</span><del>- * @since 2.1.0
- * @uses _walk_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.
</del><ins>+ * @type string $orderby How to order the links by. Accepts post fields. Default 'name'.
+ * @type string $order Whether to order bookmarks in ascending or descending order.
+ * Accepts 'ASC' (ascending) or 'DESC' (descending). Default 'ASC'.
+ * @type int $limit Amount of bookmarks to display. Accepts 1+ or -1 for all.
+ * Default -1.
+ * @type string $category Comma-separated list of category ids to include links from.
+ * Default empty.
+ * @type string $category_name Category to retrieve links for by name. Default empty.
+ * @type int|bool $hide_invisible Whether to show or hide links marked as 'invisible'. Accepts
+ * 1|true or 0|false. Default 1|true.
+ * @type int|bool $show_updated Whether to display the time the bookmark was last updated.
+ * Accepts 1|true or 0|false. Default 0|false.
+ * @type int|bool $echo Whether to echo or return the formatted bookmarks. Accepts
+ * 1|true (echo) or 0|false (return). Default 1|true.
+ * @type int|bool $categorize Whether to show links listed by category or in a single column.
+ * Accepts 1|true (by category) or 0|false (one column). Default 1|true.
+ * @type int|bool $show_description Whether to show the bookmark descriptions. Accepts 1|true or 0|false.
+ * Default 0|false.
+ * @type string $title_li What to show before the links appear. Default 'Bookmarks'.
+ * @type string $title_before The HTML or text to prepend to the $title_li string. Default '<h2>'.
+ * @type string $title_after The HTML or text to append to the $title_li string. Default '</h2>'.
+ * @type string $class The CSS class to use for the $title_li. Default 'linkcat'.
+ * @type string $category_before The HTML or text to prepend to $title_before if $categorize is true.
+ * String must contain '%id' and '%class' to inherit the category ID and
+ * the $class argument used for formatting in themes.
+ * Default '<li id="%id" class="%class">'.
+ * @type string $category_after The HTML or text to append to $title_after if $categorize is true.
+ * Default '</li>'.
+ * @type string $category_orderby How to order the bookmark category based on term scheme if $categorize
+ * is true. Default 'name'.
+ * @type string $category_order Whether to order categories in ascending or descending order if
+ * $categorize is true. Accepts 'ASC' (ascending) or 'DESC' (descending).
+ * Default 'ASC'.
+ * }
+ * @return string|null Will only return if echo option is set to not echo. Default is not return anything.
</ins><span class="cx"> */
</span><span class="cx"> function wp_list_bookmarks( $args = '' ) {
</span><span class="cx"> $defaults = array(
</span></span></pre>
</div>
</div>
</body>
</html>