[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

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

BuddyPress Activity Template.

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

Defines 1 class

BP_Activity_Template:: (6 methods):
  __construct()
  has_activities()
  next_activity()
  rewind_activities()
  user_activities()
  the_activity()


Class: BP_Activity_Template  - X-Ref

The main activity template loop class.

This is responsible for loading a group of activity items and displaying them.

__construct( $args )   X-Ref
Constructor method.

The arguments passed to this class constructor are of the same
format as {@link BP_Activity_Activity::get()}.

param: array $args {
since: 1.5.0

has_activities()   X-Ref
Whether there are activity items available in the loop.

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

next_activity()   X-Ref
Set up the next activity item and iterate index.

return: object The next activity item to iterate over.
since: 1.0.0

rewind_activities()   X-Ref
Rewind the posts and reset post index.

since: 1.0.0

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

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

return: bool True if there are more activity items to show,
since: 1.0.0

the_activity()   X-Ref
Set up the current activity item inside the loop.

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

since: 1.0.0



Generated: Thu Jul 18 01:01:42 2019 Cross-referenced by PHPXref 0.7.1