[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

/src/bp-members/classes/ -> class-bp-core-members-template.php (summary)

BuddyPress Member Template loop class.

File Size: 301 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

BP_Core_Members_Template:: (6 methods):
  __construct()
  has_members()
  next_member()
  rewind_members()
  members()
  the_member()


Class: BP_Core_Members_Template  - X-Ref

The main member template loop class.

Responsible for loading a group of members into a loop for display.

__construct( $type, $page_number, $per_page, $max, $user_id, $search_terms, $include, $populate_extras, $exclude, $meta_key, $meta_value, $page_arg = 'upage', $member_type = '', $member_type__in = '', $member_type__not_in = '' )   X-Ref
Constructor method.

since: 1.5.0
param: string       $type                Sort order.
param: int          $page_number         Page of results.
param: int          $per_page            Number of results per page.
param: int          $max                 Max number of results to return.
param: int          $user_id             Limit to friends of a user.
param: string       $search_terms        Limit to users matching search terms.
param: array        $include             Limit results by these user IDs.
param: bool         $populate_extras     Fetch optional extras.
param: array        $exclude             Exclude these IDs from results.
param: array        $meta_key            Limit to users with a meta_key.
param: array        $meta_value          Limit to users with a meta_value (with meta_key).
param: string       $page_arg            Optional. The string used as a query parameter in pagination links.
param: array|string $member_type         Array or comma-separated string of member types to limit results to.
param: array|string $member_type__in     Array or comma-separated string of member types to limit results to.
param: array|string $member_type__not_in Array or comma-separated string of member types to exclude

has_members()   X-Ref
Whether there are members available in the loop.

since: 1.0.0
return: bool True if there are items in the loop, otherwise false.

next_member()   X-Ref
Set up the next member and iterate index.

since: 1.0.0
return: object The next member to iterate over.

rewind_members()   X-Ref
Rewind the members and reset member index.

since: 1.0.0

members()   X-Ref
Whether there are members left in the loop to iterate over.

This method is used by {@link bp_members()} as part of the while loop
that controls iteration inside the members loop, eg:
while ( bp_members() ) { ...

since: 1.2.0
return: bool True if there are more members to show, otherwise false.

the_member()   X-Ref
Set up the current member inside the loop.

Used by {@link bp_the_member()} to set up the current member data
while looping, so that template tags used during that iteration make
reference to the current member.

since: 1.0.0



Generated: Sun Dec 8 01:01:37 2019 Cross-referenced by PHPXref 0.7.1