Skip to:
Content

BuddyPress.org

Changeset 9798


Ignore:
Timestamp:
04/24/2015 05:11:33 PM (4 years ago)
Author:
dcavins
Message:

Improve documentation for BP_Group_Extension.

Correct and expand on documentation for $access and $show_tab
parameters. Add specific warning about how the 'mod' group member
type doesn't include group admins in group schema.

File:
1 edited

Legend:

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

    r9517 r9798  
    357357     *           information for the extension screens. See docblock of
    358358     *           {@link BP_Group_Extension} for more details.
    359      *     @type string $access Which users can visit the plugin's tab.
     359     *     @type string|array $access Which users can visit the plugin's tab.
    360360     *           Possible values: 'anyone', 'loggedin', 'member',
    361      *           'mod', 'admin' or 'noone'
    362      *           ('member', 'mod', 'admin' refer to user's role in group.)
     361     *           'mod', 'admin' or 'noone'. ('member', 'mod', 'admin'
     362     *           refer to user's role in group.) Note that 'mod' targets only
     363     *           group moderators. If you want to allow access to group
     364     *           moderators and admins, specify `array( 'mod', 'admin' )`.
    363365     *           Defaults to 'anyone' for public groups and 'member' for
    364366     *           private groups.
    365      *     @type string $show_tab Which users can see the plugin's navigation
    366      *          tab.
     367     *     @type string|array $show_tab Which users can see the plugin's
     368     *           navigation tab.
    367369     *           Possible values: 'anyone', 'loggedin', 'member',
    368      *           'mod', 'admin' or 'noone'
    369      *           ('member', 'mod', 'admin' refer to user's role in group.)
     370     *           'mod', 'admin' or 'noone'. ('member', 'mod', 'admin'
     371     *           refer to user's role in group.) Note that 'mod' targets only
     372     *           group moderators. If you want to show the tab to group
     373     *           moderators and admins, specify `array( 'mod', 'admin' )`.
    370374     *           Defaults to 'anyone' for public groups and 'member' for
    371375     *           private groups.
Note: See TracChangeset for help on using the changeset viewer.