BP_Blogs_Template::__construct( string $type, string $page, string $per_page, string $max, string $user_id, string $search_terms, string $page_arg = 'bpage', bool $update_meta_cache = true, array|bool $include_blog_ids = false )

Constructor method.


Description Description

See also See also


Top ↑

Parameters Parameters

$type

(string) (Required) See BP_Blogs_Blog::get().

$page

(string) (Required) See BP_Blogs_Blog::get().

$per_page

(string) (Required) See BP_Blogs_Blog::get().

$max

(string) (Required) See BP_Blogs_Blog::get().

$user_id

(string) (Required) See BP_Blogs_Blog::get().

$search_terms

(string) (Required) See BP_Blogs_Blog::get().

$page_arg

(string) (Optional) The string used as a query parameter in pagination links. Default: 'bpage'.

Default value: 'bpage'

$update_meta_cache

(bool) (Optional) Whether to pre-fetch metadata for queried blogs.

Default value: true

$include_blog_ids

(array|bool) (Optional) Array of blog IDs to include.

Default value: false


Top ↑

Source Source

File: bp-blogs/classes/class-bp-blogs-template.php

	public function __construct( $type, $page, $per_page, $max, $user_id, $search_terms, $page_arg = 'bpage', $update_meta_cache = true, $include_blog_ids = false ) {

		$this->pag_arg  = sanitize_key( $page_arg );
		$this->pag_page = bp_sanitize_pagination_arg( $this->pag_arg, $page     );
		$this->pag_num  = bp_sanitize_pagination_arg( 'num',          $per_page );

		// Backwards compatibility support for blogs by first letter.
		if ( ! empty( $_REQUEST['letter'] ) ) {
			$this->blogs = BP_Blogs_Blog::get_by_letter( $_REQUEST['letter'], $this->pag_num, $this->pag_page );

		// Typical blogs query.
		} else {
			$this->blogs = bp_blogs_get_blogs( array(
				'type'              => $type,
				'per_page'          => $this->pag_num,
				'page'              => $this->pag_page,
				'user_id'           => $user_id,
				'search_terms'      => $search_terms,
				'update_meta_cache' => $update_meta_cache,
				'include_blog_ids'  => $include_blog_ids,
			) );
		}

		// Set the total blog count.
		if ( empty( $max ) || ( $max >= (int) $this->blogs['total'] ) ) {
			$this->total_blog_count = (int) $this->blogs['total'];
		} else {
			$this->total_blog_count = (int) $max;
		}

		// Set the blogs array (to loop through later.
		$this->blogs = $this->blogs['blogs'];

		// Get the current blog count to compare maximum against.
		$blog_count = count( $this->blogs );

		// Set the current blog count.
		if ( empty( $max ) || ( $max >= (int) $blog_count ) ) {
			$this->blog_count = (int) $blog_count;
		} else {
			$this->blog_count = (int) $max;
		}

		// Build pagination links based on total blogs and current page number.
		if ( ! empty( $this->total_blog_count ) && ! empty( $this->pag_num ) ) {
			$this->pag_links = paginate_links( array(
				'base'      => add_query_arg( $this->pag_arg, '%#%' ),
				'format'    => '',
				'total'     => ceil( (int) $this->total_blog_count / (int) $this->pag_num ),
				'current'   => (int) $this->pag_page,
				'prev_text' => _x( '←', 'Blog pagination previous text', 'buddypress' ),
				'next_text' => _x( '→', 'Blog pagination next text',     'buddypress' ),
				'mid_size'  => 1,
				'add_args'  => array(),
			) );
		}
	}


Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.