[buddypress-trac] [BuddyPress Trac] #7292: groups_get_groups is missing params description

buddypress-trac noreply at wordpress.org
Sun Oct 16 15:05:28 UTC 2016


#7292: groups_get_groups is missing params description
--------------------------+-----------------
 Reporter:  danbp         |      Owner:
     Type:  defect (bug)  |     Status:  new
 Priority:  normal        |  Milestone:  2.7
Component:  Groups        |    Version:
 Severity:  normal        |   Keywords:
--------------------------+-----------------
 Mentionned function need some array description for the newly introduced
 params in 2.6 and 2.7
 {{{#!php
 <?php
         $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,
         );
 }}}

--
Ticket URL: <https://buddypress.trac.wordpress.org/ticket/7292>
BuddyPress Trac <http://buddypress.org/>
BuddyPress Trac


More information about the buddypress-trac mailing list