Changeset 11182 for trunk/src/bp-groups/bp-groups-functions.php

Timestamp:

10/06/2016 09:02:40 PM (8 years ago)

Author:

r-a-y

Message:

Groups: Add 'create_screen_checked' argument to bp_groups_register_group_type().

If $show_in_create_screen is true, whether we should have our group type
checkbox checked by default during the group creation process. Handy if you
want to imply that the group type should be enforced, but decision
ultimately lies with the group creator.

Props hnla, dcavins.

See #7210.

File:

• trunk/src/bp-groups/bp-groups-functions.php (modified) (3 diffs)

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

@@ -2117 +2117 @@
  * @since 2.6.0
  * @since 2.7.0 Introduce $has_directory, $show_in_create_screen, $show_in_list, and
- *              $description as $args parameters.
+ *              $description, $create_screen_checked as $args parameters.
  *
  * @param string $group_type Unique string identifier for the group type.
@@ -2132 +2132 @@
  *     @type string      $description           A short descriptive summary of what the group type is. Currently shown
  *                                              on a group's "Manage > Settings" page when selecting group types.
+ *     @type bool        $create_screen_checked If $show_in_create_screen is true, whether we should have our group type
+ *                                              checkbox checked by default. Handy if you want to imply that the group
+ *                                              type should be enforced, but decision lies with the group creator.
+ *                                              Default: false.
  *     @type array       $labels {
  *         Array of labels to use in various parts of the interface.
@@ -2153 +2157 @@
         'show_in_list'          => null,
         'description'           => '',
+        'create_screen_checked' => false,
         'labels'                => array(),
     ), 'register_group_type' );