Changeset 9798

Timestamp:

04/24/2015 05:11:33 PM (10 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:

• trunk/src/bp-groups/classes/class-bp-group-extension.php (modified) (1 diff)

trunk/src/bp-groups/classes/class-bp-group-extension.php

@@ -357 +357 @@
      *           information for the extension screens. See docblock of
      *           {@link BP_Group_Extension} for more details.
-     *     @type string $access Which users can visit the plugin's tab.
+     *     @type string|array $access Which users can visit the plugin's tab.
      *           Possible values: 'anyone', 'loggedin', 'member',
-     *           'mod', 'admin' or 'noone'
-     *           ('member', 'mod', 'admin' refer to user's role in group.)
+     *           'mod', 'admin' or 'noone'. ('member', 'mod', 'admin'
+     *           refer to user's role in group.) Note that 'mod' targets only
+     *           group moderators. If you want to allow access to group
+     *           moderators and admins, specify `array( 'mod', 'admin' )`.
      *           Defaults to 'anyone' for public groups and 'member' for
      *           private groups.
-     *     @type string $show_tab Which users can see the plugin's navigation
-     *           tab.
+     *     @type string|array $show_tab Which users can see the plugin's
+     *           navigation tab.
      *           Possible values: 'anyone', 'loggedin', 'member',
-     *           'mod', 'admin' or 'noone'
-     *           ('member', 'mod', 'admin' refer to user's role in group.)
+     *           'mod', 'admin' or 'noone'. ('member', 'mod', 'admin'
+     *           refer to user's role in group.) Note that 'mod' targets only
+     *           group moderators. If you want to show the tab to group
+     *           moderators and admins, specify `array( 'mod', 'admin' )`.
      *           Defaults to 'anyone' for public groups and 'member' for
      *           private groups.