Skip to:
Content

BuddyPress.org

Changeset 9365


Ignore:
Timestamp:
01/15/2015 09:33:26 PM (7 years ago)
Author:
tw2113
Message:

Fix punctuation and out-of-date docs for BP_Group_Extension::init().

Props dcavins.

Fixes #6070.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-groups/bp-groups-classes.php

    r9351 r9365  
    27742774 * supports the following values:
    27752775 *   - 'slug' A unique identifier for your extension. This value will be used
    2776  *     to build URLs, so make it URL-safe
     2776 *     to build URLs, so make it URL-safe.
    27772777 *   - 'name' A translatable name for your extension. This value is used to
    2778        populate the navigation tab, as well as the default titles for admin/
    2779        edit/create tabs.
     2778 *     populate the navigation tab, as well as the default titles for admin/
     2779 *     edit/create tabs.
    27802780 *   - 'visibility' Set to 'public' (default) for your extension (the main tab
    27812781 *     as well as the widget) to be available to anyone who can access the
    27822782 *     group, 'private' otherwise.
    27832783 *   - 'nav_item_position' An integer explaining where the nav item should
    2784  *     appear in the tab list
     2784 *     appear in the tab list.
    27852785 *   - 'enable_nav_item' Set to true for your extension's main tab to be
    27862786 *     available to anyone who can access the group.
     
    27882788 *     Defaults to the value of 'name'.
    27892789 *   - 'display_hook' The WordPress action that the widget_display() method is
    2790  *     hooked to
     2790 *     hooked to.
    27912791 *   - 'template_file' The template file that will be used to load the content
    27922792 *     of your main extension tab. Defaults to 'groups/single/plugins.php'.
    2793  *   - 'screens' A multi-dimensional array, described below
     2793 *   - 'screens' A multi-dimensional array, described below.
     2794 *   - 'access' Which users can visit the plugin's tab.
     2795 *   - 'show_tab' Which users can see the plugin's navigation tab.
    27942796 *
    27952797 * BP_Group_Extension uses the concept of "settings screens". There are three
     
    30823084     *   }
    30833085     *
    3084      * @since BuddyPress (1.8)
     3086     * @since BuddyPress (1.8.0)
     3087     * @since BuddyPress (2.1.0) Added 'access' and 'show_tab' arguments
     3088     *        to $args.
    30853089     * @param array $args {
    30863090     *     Array of initialization arguments.
     
    31093113     *           information for the extension screens. See docblock of
    31103114     *           {@link BP_Group_Extension} for more details.
     3115     *     @type string $access Which users can visit the plugin's tab.
     3116     *           Possible values: 'anyone', 'loggedin', 'member',
     3117     *           'mod', 'admin' or 'noone'
     3118     *           ('member', 'mod', 'admin' refer to user's role in group.)
     3119     *           Defaults to 'anyone' for public groups and 'member' for
     3120     *           private groups.
     3121     *     @type string $show_tab Which users can see the plugin's navigation
     3122     *           tab.
     3123     *           Possible values: 'anyone', 'loggedin', 'member',
     3124     *           'mod', 'admin' or 'noone'
     3125     *           ('member', 'mod', 'admin' refer to user's role in group.)
     3126     *           Defaults to 'anyone' for public groups and 'member' for
     3127     *           private groups.
    31113128     * }
    31123129     */
Note: See TracChangeset for help on using the changeset viewer.