[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

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

BuddyPress Notifications Template Loop Class.

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

Defines 1 class

BP_Notifications_Template:: (6 methods):
  __construct()
  has_notifications()
  next_notification()
  rewind_notifications()
  notifications()
  the_notification()


Class: BP_Notifications_Template  - X-Ref

The main notifications template loop class.

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

__construct( $args = array()   X-Ref
Constructor method.

param: array $args {
since: 1.9.0

has_notifications()   X-Ref
Whether there are notifications available in the loop.

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

next_notification()   X-Ref
Set up the next notification and iterate index.

return: object The next notification to iterate over.
since: 1.9.0

rewind_notifications()   X-Ref
Rewind the blogs and reset blog index.

since: 1.9.0

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

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

return: bool True if there are more notifications to show,
since: 1.9.0

the_notification()   X-Ref
Set up the current notification inside the loop.

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

since: 1.9.0



Generated: Wed Nov 20 01:01:38 2019 Cross-referenced by PHPXref 0.7.1