[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

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

BuddyPress Blogs Template Class.

File Size: 246 lines (6 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( $type, $page, $per_page, $max, $user_id, $search_terms, $page_arg = 'bpage', $update_meta_cache = true, $include_blog_ids = false )   X-Ref
Constructor method.

param: string     $type              See {@link BP_Blogs_Blog::get()}.
param: string     $page              See {@link BP_Blogs_Blog::get()}.
param: string     $per_page          See {@link BP_Blogs_Blog::get()}.
param: string     $max               See {@link BP_Blogs_Blog::get()}.
param: string     $user_id           See {@link BP_Blogs_Blog::get()}.
param: string     $search_terms      See {@link BP_Blogs_Blog::get()}.
param: string     $page_arg          The string used as a query parameter in
param: bool       $update_meta_cache Whether to pre-fetch metadata for
param: array|bool $include_blog_ids  Array of blog IDs to include.

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.




Generated: Tue Oct 15 01:01:36 2019 Cross-referenced by PHPXref 0.7.1