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

BuddyPress Groups Template loop class.

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

Defines 1 class

BP_Groups_Template:: (6 methods):
  __construct()
  has_groups()
  next_group()
  rewind_groups()
  groups()
  the_group()

Class: BP_Groups_Template - X-Ref

The main Groups template loop class.

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

__construct( ...$args ) X-Ref

Constructor method.

param: array $args {

has_groups() X-Ref

Whether there are groups available in the loop.

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

next_group() X-Ref

Set up the next group and iterate index.

return: object The next group to iterate over.
since: 1.2.0

rewind_groups() X-Ref

Rewind the groups and reset member index.

since: 1.2.0

groups() X-Ref

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

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

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

the_group() X-Ref

Set up the current group inside the loop.

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

since: 1.2.0

PHP Cross Reference of BuddyPress

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

Defines 1 class