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

BuddyPress Members Invitation Template Loop Class.

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

Defines 1 class

BP_Members_Invitations_Template:: (6 methods):
  __construct()
  has_invitations()
  next_invitation()
  rewind_invitations()
  invitations()
  the_invitation()

Class: BP_Members_Invitations_Template - X-Ref

The main membership invitations template loop class.

Responsible for loading a group of membership invitations into a loop for display.

__construct( $args = array() X-Ref

Constructor method.

param: array $args {
since: 8.0.0

has_invitations() X-Ref

Whether there are invitations available in the loop.

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

next_invitation() X-Ref

Set up the next invitation and iterate index.

since: 8.0.0
return: object The next invitation to iterate over.

rewind_invitations() X-Ref

Rewind the blogs and reset blog index.

since: 8.0.0

invitations() X-Ref

Whether there are invitations left in the loop to iterate over.

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

since: 8.0.0
return: bool True if there are more invitations to show,

the_invitation() X-Ref

Set up the current invitation inside the loop.

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

since: 8.0.0

PHP Cross Reference of BuddyPress

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

Defines 1 class