PHPXRef 0.7.1 : BuddyPress : Detail view of class-bp-core-members-template.php

BuddyPress Member Template loop class.

File Size:	365 lines (9 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( ...$args ) X-Ref

Constructor method.

param: array ...$args {
since: 1.5.0
since: 7.0.0 Added `$xprofile_query` parameter. Added `$user_ids` parameter.
since: 10.0.0 Added `$date_query` parameter.

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

PHP Cross Reference of BuddyPress

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

Defines 1 class