Changeset 9365

Timestamp:

01/15/2015 09:33:26 PM (10 years ago)

Author:

tw2113

Message:

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

Props dcavins.

Fixes #6070.

File:

• trunk/src/bp-groups/bp-groups-classes.php (modified) (4 diffs)

trunk/src/bp-groups/bp-groups-classes.php

@@ -2774 +2774 @@
  * supports the following values:
  *   - 'slug' A unique identifier for your extension. This value will be used
- *     to build URLs, so make it URL-safe
+ *     to build URLs, so make it URL-safe.
  *   - 'name' A translatable name for your extension. This value is used to
-       populate the navigation tab, as well as the default titles for admin/
-       edit/create tabs.
+ *     populate the navigation tab, as well as the default titles for admin/
+ *     edit/create tabs.
  *   - 'visibility' Set to 'public' (default) for your extension (the main tab
  *     as well as the widget) to be available to anyone who can access the
  *     group, 'private' otherwise.
  *   - 'nav_item_position' An integer explaining where the nav item should
- *     appear in the tab list
+ *     appear in the tab list.
  *   - 'enable_nav_item' Set to true for your extension's main tab to be
  *     available to anyone who can access the group.
@@ -2788 +2788 @@
  *     Defaults to the value of 'name'.
  *   - 'display_hook' The WordPress action that the widget_display() method is
- *     hooked to
+ *     hooked to.
  *   - 'template_file' The template file that will be used to load the content
  *     of your main extension tab. Defaults to 'groups/single/plugins.php'.
- *   - 'screens' A multi-dimensional array, described below
+ *   - 'screens' A multi-dimensional array, described below.
+ *   - 'access' Which users can visit the plugin's tab.
+ *   - 'show_tab' Which users can see the plugin's navigation tab.
  *
  * BP_Group_Extension uses the concept of "settings screens". There are three
@@ -3082 +3084 @@
      *   }
      *
-     * @since BuddyPress (1.8)
+     * @since BuddyPress (1.8.0)
+     * @since BuddyPress (2.1.0) Added 'access' and 'show_tab' arguments
+     *        to $args.
      * @param array $args {
      *     Array of initialization arguments.
@@ -3109 +3113 @@
      *           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.
+     *           Possible values: 'anyone', 'loggedin', 'member',
+     *           'mod', 'admin' or 'noone'
+     *           ('member', 'mod', 'admin' refer to user's role in group.)
+     *           Defaults to 'anyone' for public groups and 'member' for
+     *           private groups.
+     *     @type string $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.)
+     *           Defaults to 'anyone' for public groups and 'member' for
+     *           private groups.
      * }
      */