Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
07/12/2015 12:49:36 AM (9 years ago)
Author:
tw2113
Message:

First pass at BP-Core docs cleanup.

See #6398.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-core/classes/class-bp-button.php

    r9819 r10012  
    1717 * @param array $args {
    1818 *     Array of arguments.
    19  *     @type string $id String describing the button type.
    20  *     @type string $component The name of the component the button belongs to.
    21  *           Default: 'core'.
    22  *     @type bool $must_be_logged_in Optional. Does the user need to be logged
    23  *           in to see this button? Default: true.
    24  *     @type bool $block_self Optional. True if the button should be hidden
    25  *           when a user is viewing his own profile. Default: true.
    26  *     @type string|bool $wrapper Optional. HTML element type that should wrap
    27  *           the button: 'div', 'span', 'p', or 'li'. False for no wrapper at
    28  *           all. Default: 'div'.
    29  *     @type string $wrapper_id Optional. DOM ID of the button wrapper element.
    30  *           Default: ''.
    31  *     @type string $wrapper_class Optional. DOM class of the button wrapper
    32  *           element. Default: ''.
    33  *     @type string $link_href Optional. Destination link of the button.
    34  *           Default: ''.
    35  *     @type string $link_class Optional. DOM class of the button. Default: ''.
    36  *     @type string $link_id Optional. DOM ID of the button. Default: ''.
    37  *     @type string $link_rel Optional. DOM 'rel' attribute of the button.
    38  *           Default: ''.
    39  *     @type string $link_title Optional. Title attribute of the button.
    40  *           Default: ''.
    41  *     @type string $link_text Optional. Text to appear on the button.
    42  *           Default: ''.
     19 *
     20 *     @type string      $id                String describing the button type.
     21 *     @type string      $component         The name of the component the button belongs to.
     22 *                                          Default: 'core'.
     23 *     @type bool        $must_be_logged_in Optional. Does the user need to be logged
     24 *                                          in to see this button? Default: true.
     25 *     @type bool        $block_self        Optional. True if the button should be hidden
     26 *                                          when a user is viewing his own profile.
     27 *                                          Default: true.
     28 *     @type string|bool $wrapper           Optional. HTML element type that should wrap
     29 *                                          the button: 'div', 'span', 'p', or 'li'.
     30 *                                          False for no wrapper at all. Default: 'div'.
     31 *     @type string      $wrapper_id        Optional. DOM ID of the button wrapper element.
     32 *                                          Default: ''.
     33 *     @type string      $wrapper_class     Optional. DOM class of the button wrapper
     34 *                                          element. Default: ''.
     35 *     @type string      $link_href         Optional. Destination link of the button.
     36 *                                          Default: ''.
     37 *     @type string      $link_class        Optional. DOM class of the button. Default: ''.
     38 *     @type string      $link_id           Optional. DOM ID of the button. Default: ''.
     39 *     @type string      $link_rel          Optional. DOM 'rel' attribute of the button.
     40 *                                          Default: ''.
     41 *     @type string      $link_title        Optional. Title attribute of the button.
     42 *                                          Default: ''.
     43 *     @type string      $link_text         Optional. Text to appear on the button.
     44 *                                          Default: ''.
    4345 * }
    4446 */
    … …  
    153155     * @since BuddyPress (1.2.6)
    154156     *
    155      * @param array $args See {@BP_Button}.
    156      * @return bool|null Returns false when the button is not allowed for
    157      *         the current context.
     157     * @param array|string $args See {@BP_Button}.
    158158     */
    159159    public function __construct( $args = '' ) {
Note: See TracChangeset for help on using the changeset viewer.