Skip to:
Content

BuddyPress.org

Changeset 9221


Ignore:
Timestamp:
12/10/2014 05:38:16 AM (5 years ago)
Author:
r-a-y
Message:

Update parameters in DocBlock for bp_has_groups().

Props dcavins. Fixes #6034.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-groups/bp-groups-template.php

    r9127 r9221  
    424424 * @param array $args {
    425425 *     Array of parameters. All items are optional.
    426  *     @type string $type Optional. Shorthand for certain orderby/
     426 *     @type string $type Shorthand for certain orderby/
    427427 *           order combinations. 'newest', 'active', 'popular',
    428428 *           'alphabetical', 'random'. When present, will override
    429429 *           orderby and order params. Default: null.
    430  *     @type string $orderby Optional. Property to sort by.
     430 *     @type string $orderby Property to sort by.
    431431 *           'date_created', 'last_activity', 'total_member_count',
    432432 *           'name', 'random'. Default: 'date_created'.
    433  *     @type string $order Optional. Sort order. 'ASC' or 'DESC'.
     433 *     @type string $order Sort order. 'ASC' or 'DESC'.
    434434 *           Default: 'DESC'.
    435  *     @type int $per_page Optional. Number of items to return per page
     435 *     @type int $per_page Number of items to return per page
    436436 *           of results. Default: null (no limit).
    437  *     @type int $page Optional. Page offset of results to return.
     437 *     @type int $page Page offset of results to return.
    438438 *           Default: null (no limit).
    439  *     @type int $user_id Optional. If provided, results will be limited
     439 *     @type int $user_id If provided, results will be limited
    440440 *           to groups of which the specified user is a member. Default:
    441441 *           null.
    442  *     @type string $search_terms Optional. If provided, only groups
     442 *     @type string $search_terms If provided, only groups
    443443 *           whose names or descriptions match the search terms will be
    444444 *           returned. Default: false.
    445  *     @type array $meta_query Optional. An array of meta_query
     445 *     @type array $meta_query An array of meta_query
    446446 *           conditions. See {@link WP_Meta_Query::queries} for
    447447 *           description.
    448  *     @type array|string Optional. Array or comma-separated list of
     448 *     @type array|string $include Array or comma-separated list of
    449449 *           group IDs. Results will be limited to groups within the
    450450 *           list. Default: false.
     
    452452 *           information (such as member count) about groups. Default:
    453453 *           true.
    454  *     @type array|string Optional. Array or comma-separated list of
     454 *     @type array|string $exclude Array or comma-separated list of
    455455 *           group IDs. Results will exclude the listed groups.
    456456 *           Default: false.
Note: See TracChangeset for help on using the changeset viewer.