WordPress.org

Make WordPress Core

Changeset 49688


Ignore:
Timestamp:
11/24/2020 12:27:49 PM (3 months ago)
Author:
SergeyBiryukov
Message:

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

Follow-up to [32906].

See #51855, #51800.

File:
1 edited

Legend:

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

    r49193 r49688  
    169169 *     Optional. String or array of arguments to list bookmarks.
    170170 *
    171  *     @type string   $orderby          How to order the links by. Accepts post fields. Default 'name'.
    172  *     @type string   $order            Whether to order bookmarks in ascending or descending order.
    173  *                                      Accepts 'ASC' (ascending) or 'DESC' (descending). Default 'ASC'.
    174  *     @type int      $limit            Amount of bookmarks to display. Accepts 1+ or -1 for all.
    175  *                                      Default -1.
    176  *     @type string   $category         Comma-separated list of category IDs to include links from.
    177  *                                      Default empty.
    178  *     @type string   $category_name    Category to retrieve links for by name. Default empty.
    179  *     @type int|bool $hide_invisible   Whether to show or hide links marked as 'invisible'. Accepts
    180  *                                      1|true or 0|false. Default 1|true.
    181  *     @type int|bool $show_updated     Whether to display the time the bookmark was last updated.
    182  *                                      Accepts 1|true or 0|false. Default 0|false.
    183  *     @type int|bool $echo             Whether to echo or return the formatted bookmarks. Accepts
    184  *                                      1|true (echo) or 0|false (return). Default 1|true.
    185  *     @type int|bool $categorize       Whether to show links listed by category or in a single column.
    186  *                                      Accepts 1|true (by category) or 0|false (one column). Default 1|true.
    187  *     @type int|bool $show_description Whether to show the bookmark descriptions. Accepts 1|true or 0|false.
    188  *                                      Default 0|false.
    189  *     @type string   $title_li         What to show before the links appear. Default 'Bookmarks'.
    190  *     @type string   $title_before     The HTML or text to prepend to the $title_li string. Default '<h2>'.
    191  *     @type string   $title_after      The HTML or text to append to the $title_li string. Default '</h2>'.
    192  *     @type string   $class            The CSS class to use for the $title_li. Default 'linkcat'.
    193  *     @type string   $category_before  The HTML or text to prepend to $title_before if $categorize is true.
    194  *                                      String must contain '%id' and '%class' to inherit the category ID and
    195  *                                      the $class argument used for formatting in themes.
    196  *                                      Default '<li id="%id" class="%class">'.
    197  *     @type string   $category_after   The HTML or text to append to $title_after if $categorize is true.
    198  *                                      Default '</li>'.
    199  *     @type string   $category_orderby How to order the bookmark category based on term scheme if $categorize
    200  *                                      is true. Default 'name'.
    201  *     @type string   $category_order   Whether to order categories in ascending or descending order if
    202  *                                      $categorize is true. Accepts 'ASC' (ascending) or 'DESC' (descending).
    203  *                                      Default 'ASC'.
     171 *     @type string       $orderby          How to order the links by. Accepts post fields. Default 'name'.
     172 *     @type string       $order            Whether to order bookmarks in ascending or descending order.
     173 *                                          Accepts 'ASC' (ascending) or 'DESC' (descending). Default 'ASC'.
     174 *     @type int          $limit            Amount of bookmarks to display. Accepts 1+ or -1 for all.
     175 *                                          Default -1.
     176 *     @type string       $category         Comma-separated list of category IDs to include links from.
     177 *                                          Default empty.
     178 *     @type string       $category_name    Category to retrieve links for by name. Default empty.
     179 *     @type int|bool     $hide_invisible   Whether to show or hide links marked as 'invisible'. Accepts
     180 *                                          1|true or 0|false. Default 1|true.
     181 *     @type int|bool     $show_updated     Whether to display the time the bookmark was last updated.
     182 *                                          Accepts 1|true or 0|false. Default 0|false.
     183 *     @type int|bool     $echo             Whether to echo or return the formatted bookmarks. Accepts
     184 *                                          1|true (echo) or 0|false (return). Default 1|true.
     185 *     @type int|bool     $categorize       Whether to show links listed by category or in a single column.
     186 *                                          Accepts 1|true (by category) or 0|false (one column). Default 1|true.
     187 *     @type int|bool     $show_description Whether to show the bookmark descriptions. Accepts 1|true or 0|false.
     188 *                                          Default 0|false.
     189 *     @type string       $title_li         What to show before the links appear. Default 'Bookmarks'.
     190 *     @type string       $title_before     The HTML or text to prepend to the $title_li string. Default '<h2>'.
     191 *     @type string       $title_after      The HTML or text to append to the $title_li string. Default '</h2>'.
     192 *     @type string|array $class            The CSS class or an array of classes to use for the $title_li.
     193 *                                          Default 'linkcat'.
     194 *     @type string       $category_before  The HTML or text to prepend to $title_before if $categorize is true.
     195 *                                          String must contain '%id' and '%class' to inherit the category ID and
     196 *                                          the $class argument used for formatting in themes.
     197 *                                          Default '<li id="%id" class="%class">'.
     198 *     @type string       $category_after   The HTML or text to append to $title_after if $categorize is true.
     199 *                                          Default '</li>'.
     200 *     @type string       $category_orderby How to order the bookmark category based on term scheme if $categorize
     201 *                                          is true. Default 'name'.
     202 *     @type string       $category_order   Whether to order categories in ascending or descending order if
     203 *                                          $categorize is true. Accepts 'ASC' (ascending) or 'DESC' (descending).
     204 *                                          Default 'ASC'.
    204205 * }
    205206 * @return void|string Void if 'echo' argument is true, HTML list of bookmarks if 'echo' is false.
Note: See TracChangeset for help on using the changeset viewer.