Skip to:

Opened 7 years ago

Closed 7 years ago

#7292 closed enhancement (fixed)

groups_get_groups is missing params description

Reported by: danbp's profile danbp Owned by: hnla's profile hnla
Milestone: 2.7 Priority: normal
Severity: minor Version:
Component: Groups Keywords: has-patch
Cc: danco38@…


Mentionned function need some array description for the newly introduced params in 2.6 and 2.7

        $defaults = array(
                'type'               => false,          // Active, newest, alphabetical, random, popular, most-forum-topics or most-forum-posts.
                'order'              => 'DESC',         // 'ASC' or 'DESC'
                'orderby'            => 'date_created', // date_created, last_activity, total_member_count, name, random.
                'user_id'            => false,          // Pass a user_id to limit to only groups that this user is a member of.
                'include'            => false,          // Only include these specific groups (group_ids).
                'exclude'            => false,          // Do not include these specific groups (group_ids).
                'parent_id'          => null,           // Get groups that are children of the specified group(s).
                'search_terms'       => false,          // Limit to groups that match these search terms.
                'group_type'         => '',
                'group_type__in'     => '',
                'group_type__not_in' => '',
                'meta_query'         => false,          // Filter by groupmeta. See WP_Meta_Query for syntax.
                'show_hidden'        => false,          // Show hidden groups to non-admins.
                'per_page'           => 20,             // The number of results to return per page.
                'page'               => 1,              // The page to return if limiting per page.
                'update_meta_cache'  => true,           // Pre-fetch groupmeta for queried groups.
                'update_admin_cache' => false,

Attachments (1)

7292.patch (1.2 KB) - added by hnla 7 years ago.
Add comments for group type params.

Download all attachments as: .zip

Change History (4)

#1 @hnla
7 years ago

  • Keywords has-patch added
  • Severity changed from normal to minor
  • Type changed from defect (bug) to enhancement

Should be able to copy the comments in the groups class to cover this.
Patch attached.

7 years ago

Add comments for group type params.

#2 @hnla
7 years ago

  • Owner set to hnla
  • Status changed from new to accepted

#3 @hnla
7 years ago

  • Resolution set to fixed
  • Status changed from accepted to closed

In 11196:

Add groups_get_groups parameter comments

Commit adds missing parameter comments for group 'type' args.
Copies existing ones from groups class.

Fixes #7292 Props danbp

Note: See TracTickets for help on using tickets.