Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
05/23/2013 01:14:42 PM (9 years ago)
Author:
boonebgorges
Message:

Reformats docblock for bp_nav_menu().

  • Break lines before 80 characters
  • Indent argument descriptions for better readability
File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/bp-core/bp-core-template.php

    r6947 r7100  
    18921892 *
    18931893 * @param string|array $args Optional arguments:
    1894  *  before - Text before the link text.
    1895  *  container - Whether to wrap the ul, and what to wrap it with. Defaults to div.
    1896  *  container_class - The class that is applied to the container. Defaults to 'menu-bp-container'.
    1897  *  container_id - The ID that is applied to the container. Defaults to blank.
    1898  *  depth - How many levels of the hierarchy are to be included. 0 means all. Defaults to 0.
    1899  *  echo - Whether to echo the menu or return it. Defaults to echo.
    1900  *  fallback_cb - If the menu doesn't exists, a callback function will fire. Defaults to false (no fallback).
    1901  *  items_wrap - How the list items should be wrapped. Defaults to a ul with an id and class. Uses printf() format with numbered placeholders.
    1902  *  link_after - Text after the link.
    1903  *  link_before - Text before the link.
    1904  *  menu_class - CSS class to use for the ul element which forms the menu. Defaults to 'menu'.
    1905  *  menu_id - The ID that is applied to the ul element which forms the menu. Defaults to 'menu-bp', incremented.
    1906  *  walker - Allows a custom walker to be specified. Defaults to 'BP_Walker_Nav_Menu'.
     1894 *  - before           Text before the link text.
     1895 *  - container        Whether to wrap the ul, and what to wrap it with.
     1896 *                     Defaults to div.
     1897 *  - container_class  The class that is applied to the container. Defaults to
     1898 *                     'menu-bp-container'.
     1899 *  - container_id     The ID that is applied to the container. Defaults to
     1900 *                     blank.
     1901 *  - depth            How many levels of the hierarchy are to be included. 0
     1902 *                     means all. Defaults to 0.
     1903 *  - echo             Whether to echo the menu or return it. Defaults to echo.
     1904 *  - fallback_cb      If the menu doesn't exists, a callback function will
     1905 *                     fire. Defaults to false (no fallback).
     1906 *  - items_wrap       How the list items should be wrapped. Defaults to a ul
     1907 *                     with an id and class. Uses printf() format with numbered
     1908 *                     placeholders.
     1909 *  - link_after       Text after the link.
     1910 *  - link_before      Text before the link.
     1911 *  - menu_class       CSS class to use for the ul element which forms the menu.
     1912 *                     Defaults to 'menu'.
     1913 *  - menu_id          The ID that is applied to the ul element which forms the
     1914 *                     menu. Defaults to 'menu-bp', incremented.
     1915 *  - walker           Allows a custom walker to be specified. Defaults to
     1916 *                     'BP_Walker_Nav_Menu'.
     1917 *
    19071918 * @since BuddyPress (1.7)
    19081919 */
Note: See TracChangeset for help on using the changeset viewer.