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

BuddyPress Blogs Template Class.

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

Defines 1 class

BP_Blogs_Template:: (6 methods):
  __construct()
  has_blogs()
  next_blog()
  rewind_blogs()
  blogs()
  the_blog()

Class: BP_Blogs_Template - X-Ref

The main blog template loop class.

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

__construct( ...$args ) X-Ref

Constructor method.

param: array $args {
since: 1.2.0
since: 10.0.0 Converted to array as main function argument. Added $date_query parameter.

has_blogs() X-Ref

Whether there are blogs available in the loop.

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

next_blog() X-Ref

Set up the next blog and iterate index.

return: object The next blog to iterate over.

rewind_blogs() X-Ref

Rewind the blogs and reset blog index.

blogs() X-Ref

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

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

return: bool True if there are more blogs to show, otherwise false.

the_blog() X-Ref

Set up the current blog inside the loop.

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

PHP Cross Reference of BuddyPress

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

Defines 1 class