• Home
  • WPSEO_Admin_Banner_Sidebar

PHP Class WPSEO_Admin_Banner_Sidebar, wordpress-seo

Datei anzeigen Open project: yoast/wordpress-seo Class Usage Examples

Protected Properties

Property Type Description
$banner_renderer WPSEO_Admin_Banner_Renderer
$banner_spots WPSEO_Admin_Banner_Spot[]
$title string

Public Methods

Method Description
__construct ( string $title, WPSEO_Admin_Banner_Renderer $banner_renderer ) WPSEO_Admin_Banner_Sidebar constructor.
get_banner_spots ( ) : WPSEO_Admin_Banner_Spot[] Returns array with bannerspots.
get_title ( ) : string Returns the set title.
initialize ( WPSEO_Features $features ) Initializes the banner sidebar by setting its banner spots.

Protected Methods

Method Description
add_banner_spot ( WPSEO_Admin_Banner_Spot $spot ) Adds a banner spot.
get_active_extensions ( ) : array Returns an array with the Yoast SEO extensions with the value true when they are active.
get_courses_spot ( ) : WPSEO_Admin_Banner_Spot Returns the courses banner spot.
get_extensions_spot ( array $active_extensions ) : WPSEO_Admin_Banner_Spot Returns the extensions banner spot.
get_premium_spot ( ) : WPSEO_Admin_Banner_Spot Returns the premium banner spot.
get_remove_banner_spot ( ) : WPSEO_Admin_Banner_Spot Returns the remove banner spot.
get_services_spot ( ) : WPSEO_Admin_Banner_Spot Returns the services banner spot.

Method Details

__construct() public method

WPSEO_Admin_Banner_Sidebar constructor.
public __construct ( string $title, WPSEO_Admin_Banner_Renderer $banner_renderer )
$title string The title for the sidebar.
$banner_renderer WPSEO_Admin_Banner_Renderer The render class for banners.

add_banner_spot() protected method

Adds a banner spot.
protected add_banner_spot ( WPSEO_Admin_Banner_Spot $spot )
$spot WPSEO_Admin_Banner_Spot The spot to add.

get_active_extensions() protected method

Returns an array with the Yoast SEO extensions with the value true when they are active.
protected get_active_extensions ( ) : array
return array

get_banner_spots() public method

Returns array with bannerspots.
public get_banner_spots ( ) : WPSEO_Admin_Banner_Spot[]
return WPSEO_Admin_Banner_Spot[]

get_courses_spot() protected method

Returns the courses banner spot.
protected get_courses_spot ( ) : WPSEO_Admin_Banner_Spot
return WPSEO_Admin_Banner_Spot

get_extensions_spot() protected method

Returns the extensions banner spot.
protected get_extensions_spot ( array $active_extensions ) : WPSEO_Admin_Banner_Spot
$active_extensions array The active extensions.
return WPSEO_Admin_Banner_Spot

get_premium_spot() protected method

Returns the premium banner spot.
protected get_premium_spot ( ) : WPSEO_Admin_Banner_Spot
return WPSEO_Admin_Banner_Spot

get_remove_banner_spot() protected method

Returns the remove banner spot.
protected get_remove_banner_spot ( ) : WPSEO_Admin_Banner_Spot
return WPSEO_Admin_Banner_Spot

get_services_spot() protected method

Returns the services banner spot.
protected get_services_spot ( ) : WPSEO_Admin_Banner_Spot
return WPSEO_Admin_Banner_Spot

get_title() public method

Returns the set title.
public get_title ( ) : string
return string

initialize() public method

Initializes the banner sidebar by setting its banner spots.
public initialize ( WPSEO_Features $features )
$features WPSEO_Features Class regarding WPSEO Features.

Property Details

$banner_renderer protected_oe property

protected WPSEO_Admin_Banner_Renderer $banner_renderer
return WPSEO_Admin_Banner_Renderer

$banner_spots protected_oe property

protected WPSEO_Admin_Banner_Spot[] $banner_spots
return WPSEO_Admin_Banner_Spot[]

$title protected_oe property

protected string $title
return string