WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
11/24/2014 05:52:45 AM (12 years ago)
Author:
DrewAPicture
Message:

Ensure inline code is markdown-escaped as such, HTML tags are removed from summaries, and that code snippets in descriptions are properly indented.

Affects DocBlocks for the following core elements:

  • Backtick-escape an HTML tag in the description for the media_upload_mime_type_links() hook
  • Backtick-escape inline code in the description for wp_get_active_network_plugins()
  • Remove HTML tags from the summaries for the nav_menu_css_class, nav_menu_item_id, and nav_menu_link_attributes hooks
  • Backtick-escape HTML tags, add inline @see tags to parameter descriptions for the nav_menu_css_class, nav_menu_item_id, and nav_menu_link_attributes hooks

Props rarst.
See #30473.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/nav-menu-template.php

    r30485 r30543  
    8686
    8787                /**
    88                  * Filter the CSS class(es) applied to a menu item's <li>.
     88                 * Filter the CSS class(es) applied to a menu item's li element.
    8989                 *
    9090                 * @since 3.0.0
    9191                 * @since 4.1.0 The `$depth` parameter was added.
    9292                 *
    93                  * @see wp_nav_menu()
    94                  *
    95                  * @param array  $classes The CSS classes that are applied to the menu item's <li>.
     93                 * @param array  $classes The CSS classes that are applied to the menu item's `<li>` element.
    9694                 * @param object $item    The current menu item.
    97                  * @param array  $args    An array of wp_nav_menu() arguments.
     95                 * @param array  $args    An array of {@see wp_nav_menu()} arguments.
    9896                 * @param int    $depth   Depth of menu item. Used for padding.
    9997                 */
    … …  
    102100
    103101                /**
    104                  * Filter the ID applied to a menu item's <li>.
     102                 * Filter the ID applied to a menu item's li element.
    105103                 *
    106104                 * @since 3.0.1
    107105                 * @since 4.1.0 The `$depth` parameter was added.
    108106                 *
    109                  * @see wp_nav_menu()
    110                  *
    111                  * @param string $menu_id The ID that is applied to the menu item's <li>.
     107                 * @param string $menu_id The ID that is applied to the menu item's `<li>` element.
    112108                 * @param object $item    The current menu item.
    113                  * @param array  $args    An array of wp_nav_menu() arguments.
     109                 * @param array  $args    An array of {@see wp_nav_menu()} arguments.
    114110                 * @param int    $depth   Depth of menu item. Used for padding.
    115111                 */
    … …  
    126122
    127123                /**
    128                  * Filter the HTML attributes applied to a menu item's <a>.
     124                 * Filter the HTML attributes applied to a menu item's 'a' element.
    129125                 *
    130126                 * @since 3.6.0
    131127                 * @since 4.1.0 The `$depth` parameter was added.
    132128                 *
    133                  * @see wp_nav_menu()
    134                  *
    135129                 * @param array $atts {
    136                  *     The HTML attributes applied to the menu item's <a>, empty strings are ignored.
     130                 *     The HTML attributes applied to the menu item's `<a>` element, empty strings are ignored.
    137131                 *
    138132                 *     @type string $title  Title attribute.
    … …  
    142136                 * }
    143137                 * @param object $item  The current menu item.
    144                  * @param array  $args  An array of wp_nav_menu() arguments.
     138                 * @param array  $args  An array of {@see wp_nav_menu()} arguments.
    145139                 * @param int    $depth Depth of menu item. Used for padding.
    146140                 */
    … …  
    165159                 * Filter a menu item's starting output.
    166160                 *
    167                  * The menu item's starting output only includes $args->before, the opening <a>,
    168                  * the menu item's title, the closing </a>, and $args->after. Currently, there is
    169                  * no filter for modifying the opening and closing <li> for a menu item.
     161                 * The menu item's starting output only includes `$args->before`, the opening `<a>`,
     162                 * the menu item's title, the closing `</a>`, and `$args->after`. Currently, there is
     163                 * no filter for modifying the opening and closing `<li>` for a menu item.
    170164                 *
    171165                 * @since 3.0.0
    172                  *
    173                  * @see wp_nav_menu()
    174166                 *
    175167                 * @param string $item_output The menu item's starting HTML output.
    176168                 * @param object $item        Menu item data object.
    177169                 * @param int    $depth       Depth of menu item. Used for padding.
    178                  * @param array  $args        An array of wp_nav_menu() arguments.
     170                 * @param array  $args        An array of {@see wp_nav_menu()} arguments.
    179171                 */
    180172                $output .= apply_filters( 'walker_nav_menu_start_el', $item_output, $item, $depth, $args );
Note: See TracChangeset for help on using the changeset viewer.