HomePages class - Documentation for SproutCMS

Info Page:

Page options:

class HomePages

Functions for dealing with promo and banner images on the home page(s)

Name	Visibility	Description
getActiveBanners	public (static)	Return list of active banners for given home page
getActivePromos	public (static)	Return list of active promos for given home page
getForSubSite	public (static)	Return home page record for given sub-site
getRandomActiveBanner	public (static)	Return a randomly selected active banner for given home page

array HomePages::getActiveBanners ( int $homepage_id [, int $limit ] );

Return list of active banners for given home page

array HomePages::getActivePromos ( int $homepage_id , int $limit );

Return list of active promos for given home page

array HomePages::getForSubSite ( [ int $subsite_id ] );

Return home page record for given sub-site

array HomePages::getRandomActiveBanner ( int $homepage_id );

Return a randomly selected active banner for given home page