| 462 | | * @type string $type Shorthand for certain orderby/ |
| 463 | | * order combinations. 'newest', |
| 464 | | * 'active', 'popular', 'alphabetical', |
| 465 | | * 'random'. When present, will override |
| 466 | | * orderby and order params. Default: null. |
| 467 | | * @type string $orderby Property to sort by. |
| 468 | | * 'date_created', 'last_activity', 'total_member_count', |
| 469 | | * 'name', 'random'. Default: 'date_created'. |
| 470 | | * @type string $order Sort order. 'ASC' or 'DESC'. |
| 471 | | * Default: 'DESC'. |
| 472 | | * @type int $per_page Number of items to return per page |
| 473 | | * of results. Default: null (no limit). |
| 474 | | * @type int $page Page offset of results to return. |
| 475 | | * Default: null (no limit). |
| 476 | | * @type int $user_id If provided, results will be limited |
| 477 | | * to groups of which the specified user |
| 478 | | * is a member. Default: null. |
| 479 | | * @type string $search_terms If provided, only groups whose names or descriptions match the search terms |
| 480 | | * will be returned. Default: value of `$_REQUEST['groups_search']` or |
| 481 | | * `$_REQUEST['s']`, if present. Otherwise false. |
| 482 | | * @type array $meta_query An array of meta_query conditions. |
| 483 | | * See {@link WP_Meta_Query::queries} for description. |
| 484 | | * @type array|string $include Array or comma-separated list of |
| 485 | | * group IDs. Results will be limited |
| 486 | | * to groups within the list. Default: false. |
| 487 | | * @type bool $populate_extras Whether to fetch additional information |
| 488 | | * (such as member count) about groups. |
| 489 | | * Default: true. |
| 490 | | * @type array|string $exclude Array or comma-separated list of group IDs. |
| 491 | | * Results will exclude the listed groups. |
| 492 | | * Default: false. |
| 493 | | * @type bool $show_hidden Whether to include hidden groups in |
| 494 | | * results. Default: false. |
| | 462 | * @type string $type Shorthand for certain orderby/ |
| | 463 | * order combinations. 'newest', |
| | 464 | * 'active', 'popular', 'alphabetical', |
| | 465 | * 'random'. When present, will override |
| | 466 | * orderby and order params. Default: null. |
| | 467 | * @type string $order Sort order. 'ASC' or 'DESC'. |
| | 468 | * Default: 'DESC'. |
| | 469 | * @type string $orderby Property to sort by. |
| | 470 | * 'date_created', 'last_activity', 'total_member_count', |
| | 471 | * 'name', 'random'. Default: 'last_activity'. |
| | 472 | * @type int $page Page offset of results to return. |
| | 473 | * Default: 1 (first page of results). |
| | 474 | * @type int $per_page Number of items to return per page |
| | 475 | * of results. Default: 20. |
| | 476 | * @type int $max Does NOT affect query. May change the |
| | 477 | * reported number of total groups found, |
| | 478 | * but not the actual number of found |
| | 479 | * groups. Default: false. |
| | 480 | * @type bool $show_hidden Whether to include hidden groups in |
| | 481 | * results. Default: false. |
| | 482 | * @type string $page_arg Query argument used for pagination. |
| | 483 | * Default: 'grpage'. |
| | 484 | * @type int $user_id If provided, results will be limited |
| | 485 | * to groups of which the specified user |
| | 486 | * is a member. |
| | 487 | * Default: value of bp_displayed_user_id(). |
| | 488 | * @type string $slug If provided, only the group with the |
| | 489 | * matching slug will be returned. |
| | 490 | * Default: false. |
| | 491 | * @type string $search_terms If provided, only groups whose names or |
| | 492 | * descriptions match the search terms will |
| | 493 | * be returned. Default: value of |
| | 494 | * `$_REQUEST['groups_search']` or |
| | 495 | * `$_REQUEST['s']`, if present. Otherwise false. |
| | 496 | * @type array $meta_query An array of meta_query conditions. |
| | 497 | * See {@link WP_Meta_Query::queries} for description. |
| | 498 | * @type array|string $include Array or comma-separated list of |
| | 499 | * group IDs. Results will be limited |
| | 500 | * to groups within the list. Default: false. |
| | 501 | * @type bool $populate_extras Whether to fetch additional information |
| | 502 | * (such as member count) about groups. |
| | 503 | * Default: true. |
| | 504 | * @type array|string $exclude Array or comma-separated list of group IDs. |
| | 505 | * Results will exclude the listed groups. |
| | 506 | * Default: false. |
| | 507 | * @type bool $update_meta_cache Whether to fetch groupmeta for queried groups. |
| | 508 | * Default: true. |