Docs: Clarify that the `$class` argument of `wp_list_bookmarks()` can accept an array.

Follow-up to [32906].

See #51855, #51800.
Built from https://develop.svn.wordpress.org/trunk@49688


git-svn-id: http://core.svn.wordpress.org/trunk@49411 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2020-11-24 12:29:07 +00:00
parent 771b1048be
commit 0f9170b82d
2 changed files with 35 additions and 34 deletions

View File

@ -168,39 +168,40 @@ function _walk_bookmarks( $bookmarks, $args = '' ) {
* @param string|array $args { * @param string|array $args {
* Optional. String or array of arguments to list bookmarks. * Optional. String or array of arguments to list bookmarks.
* *
* @type string $orderby How to order the links by. Accepts post fields. Default 'name'. * @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. * @type string $order Whether to order bookmarks in ascending or descending order.
* Accepts 'ASC' (ascending) or 'DESC' (descending). Default 'ASC'. * Accepts 'ASC' (ascending) or 'DESC' (descending). Default 'ASC'.
* @type int $limit Amount of bookmarks to display. Accepts 1+ or -1 for all. * @type int $limit Amount of bookmarks to display. Accepts 1+ or -1 for all.
* Default -1. * Default -1.
* @type string $category Comma-separated list of category IDs to include links from. * @type string $category Comma-separated list of category IDs to include links from.
* Default empty. * Default empty.
* @type string $category_name Category to retrieve links for by name. 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 * @type int|bool $hide_invisible Whether to show or hide links marked as 'invisible'. Accepts
* 1|true or 0|false. Default 1|true. * 1|true or 0|false. Default 1|true.
* @type int|bool $show_updated Whether to display the time the bookmark was last updated. * @type int|bool $show_updated Whether to display the time the bookmark was last updated.
* Accepts 1|true or 0|false. Default 0|false. * Accepts 1|true or 0|false. Default 0|false.
* @type int|bool $echo Whether to echo or return the formatted bookmarks. Accepts * @type int|bool $echo Whether to echo or return the formatted bookmarks. Accepts
* 1|true (echo) or 0|false (return). Default 1|true. * 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. * @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. * 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. * @type int|bool $show_description Whether to show the bookmark descriptions. Accepts 1|true or 0|false.
* Default 0|false. * Default 0|false.
* @type string $title_li What to show before the links appear. Default 'Bookmarks'. * @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_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 $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|array $class The CSS class or an array of classes to use for the $title_li.
* @type string $category_before The HTML or text to prepend to $title_before if $categorize is true. * Default 'linkcat'.
* String must contain '%id' and '%class' to inherit the category ID and * @type string $category_before The HTML or text to prepend to $title_before if $categorize is true.
* the $class argument used for formatting in themes. * String must contain '%id' and '%class' to inherit the category ID and
* Default '<li id="%id" class="%class">'. * the $class argument used for formatting in themes.
* @type string $category_after The HTML or text to append to $title_after if $categorize is true. * Default '<li id="%id" class="%class">'.
* Default '</li>'. * @type string $category_after The HTML or text to append to $title_after if $categorize is true.
* @type string $category_orderby How to order the bookmark category based on term scheme if $categorize * Default '</li>'.
* is true. Default 'name'. * @type string $category_orderby How to order the bookmark category based on term scheme if $categorize
* @type string $category_order Whether to order categories in ascending or descending order if * is true. Default 'name'.
* $categorize is true. Accepts 'ASC' (ascending) or 'DESC' (descending). * @type string $category_order Whether to order categories in ascending or descending order if
* Default 'ASC'. * $categorize is true. Accepts 'ASC' (ascending) or 'DESC' (descending).
* Default 'ASC'.
* } * }
* @return void|string Void if 'echo' argument is true, HTML list of bookmarks if 'echo' is false. * @return void|string Void if 'echo' argument is true, HTML list of bookmarks if 'echo' is false.
*/ */

View File

@ -13,7 +13,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.7-alpha-49685'; $wp_version = '5.7-alpha-49688';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.