Changeset 11530

Timestamp:

04/09/2017 02:56:00 AM (8 years ago)

Author:

tw2113

Message:

Adds missed phpdoc for a new filter. Also adds some various param and return docs.

See #7143.

Location:

trunk/src/bp-groups

Files:

• bp-groups-admin.php (modified) (3 diffs)
• bp-groups-cache.php (modified) (2 diffs)
• bp-groups-functions.php (modified) (3 diffs)
• bp-groups-template.php (modified) (2 diffs)
• classes/class-bp-groups-group.php (modified) (1 diff)
• classes/class-bp-groups-list-table.php (modified) (1 diff)

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

@@ -874 +874 @@
             'group_role' => array( $type ),
             'type'       => 'alphabetical',
+            /**
+             * Filters the admin members type per page value.
+             *
+             * @since 2.8.0
+             *
+             * @param int    $value Member types per page. Default 10.
+             * @param string $type  Member type.
+             */
             'per_page'   => apply_filters( 'bp_groups_admin_members_type_per_page', 10, $type ),
             'page'       => $current_type_page,
@@ -1030 +1038 @@
  * @since 2.6.0
  *
- * @param BP_Groups_Group|null $user The BP_Groups_Group object corresponding to the group being edited.
+ * @param BP_Groups_Group|null $group The BP_Groups_Group object corresponding to the group being edited.
  */
 function bp_groups_admin_edit_metabox_group_type( BP_Groups_Group $group = null ) {
@@ -1076 +1084 @@
  *
  * @since 2.6.0
+ *
+ * @param int $group_id Group ID.
  */
 function bp_groups_process_group_type_update( $group_id ) {

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

@@ -232 +232 @@
  *
  * @since 2.6.0
+ *
+ * @param BP_Groups_Member $member BP Groups Member instance.
  */
 function bp_groups_clear_user_group_cache_on_membership_save( BP_Groups_Member $member ) {
@@ -244 +246 @@
  *
  * @since 2.6.0
+ *
+ * @param int $user_id  Current user ID.
+ * @param int $group_id Current group ID.
  */
 function bp_groups_clear_user_group_cache_on_other_events( $user_id, $group_id ) {

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

@@ -271 +271 @@
  * @param string|bool $invite_status Optional. Who is allowed to send invitations
  *                                   to the group. 'members', 'mods', or 'admins'.
+ * @param int|bool    $parent_id     Parent group ID.
  * @return bool True on success, false on failure.
  */
@@ -2311 +2312 @@
  * @since 2.7.0 $group_type parameter also accepts an array of group types now.
  *
- * @param int          $group      ID of the group.
+ * @param int          $group_id   ID of the group.
  * @param string|array $group_type Group type or array of group types to set.
  * @param bool         $append     Optional. True to append this to existing types for group,
@@ -2412 +2413 @@
  * @since 2.6.0
  *
- * @param int            $group      ID of the user.
+ * @param int            $group_id   ID of the user.
  * @param string         $group_type Group type.
  * @return bool|WP_Error $deleted    True on success. False or WP_Error on failure.

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

@@ -209 +209 @@
      *
      * @param int $group_id Group ID. Defaults to current group ID if on a group page.
-     * @param array|string $args {
+     * @param array|string $r {
      *     Array of parameters. All items are optional.
      *     @type string $parent_element Element to wrap around the list. Defaults to 'p'.
@@ -3787 +3787 @@
      * @since 1.0.0
      *
-     * @return type
+     * @return int
      */
     function bp_get_total_group_count() {

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

@@ -470 +470 @@
      * @since 2.7.0
      *
-     * @param string $key Property name.
+     * @param string $key   Property name.
+     * @param mixed  $value Property value.
+     * @return bool
      */
     public function __set( $key, $value ) {

trunk/src/bp-groups/classes/class-bp-groups-list-table.php

@@ -707 +707 @@
      * @since 2.7.0
      *
-     * @param string $value       Empty string.
+     * @param string $retval      Empty string.
      * @param string $column_name Name of the column being rendered.
      * @param array  $item        The current group item in the loop.
+     * @return string
      */
     public function column_content_group_type( $retval = '', $column_name, $item ) {