David & Goliath
Back to top  

WpvTemplates

class WpvTemplates

Methods

Returns the current layout type and defines WPV_LAYOUT accordingly

get_layout() : string
static

Response

string

current page layout

displays the left sidebar if there is one

left_sidebar()
static

displays the right sidebar if there is one

right_sidebar()
static

Echoes a pagination in the form of 1 2 [3] 4 5

pagination_list()
static

Displays the pagination code based on the theme options or $pagination_type

pagination(string|null $pagination_type = null)
static

Arguments

$pagination_type

string|null

overrides the pagination settings

has_breadcrumbs

has_breadcrumbs()
static

Displays the breadcrumbs if they are enabled

breadcrumbs()
static

Checks whether the current page has a title

has_page_header() : boolean
static

Response

boolean

whether the current page has a title

Page title background styles

page_header_background() : string
static

Response

string

background styles

Returns a LESS mixin for generating a readable color based on a bg color

readable_color_mixin() : string
static

Response

string

LESS mixin

Page title color

page_header_title_color() : string
static

Response

string

color styles

Checks whether the current page has post siblings links

has_post_siblings_buttons() : boolean
static

Response

boolean

whether the current page has post siblings links

Displays the page header

page_header(bool $placed = false, string|null $title = null)
static

Arguments

$placed

bool

whether the title has already been output

$title

string|null

if set, overrides the current post title

Displays the header sidebars

header_sidebars()
static

Displays the footer sidebars

footer_sidebars()
static

displays header/footer sidebars

header_footer_sidebars(string $area)
static

Arguments

$area

string

one of "header" or "footer"

Comments template

comments(object $comment, array $args, int $depth)
static

Arguments

$comment

object

comment data

$args

array

comment arguments

$depth

int

comment depth

Check if the current context has share buttons

has_share(string $context) : boolean
static

Arguments

$context

string

current view ( page, post, etc. )

Response

boolean

whether the current context has share buttons

Displays share buttons depending on $context

share(string $context)
static

Arguments

$context

string

current view ( page, post, etc. )

Displays the icon for a post format $format

post_format_icon(string $format) : string
static

Arguments

$format

string

post format slug

Response

string

icon html

Outputs the page title styles

get_title_style()
static

Checks whether the current page has a header slider

has_header_slider() : boolean
static

Response

boolean

true if there is a header slider

Returns the list of all embeddable sliders to be used in the config generator

get_all_sliders() : array
static

Response

array

list of sliders

Returns the list of Revolution Slider sliders in 'revslider-ID' => 'Name' array

get_rev_sliders($prefix = 'revslider-') : array
static

Arguments

$prefix

Response

array

list of Revolution Slider WP sliders

Returns the list of LayerSlider sliders in 'layerslider-ID' => 'Name' array

get_layer_sliders($prefix = 'layerslider-') : array
static

Arguments

$prefix

Response

array

list of LayerSlider WP sliders

The formatted output of a list of pages.

custom_link_pages(string|array $args = '') : string
static

Displays page links for paginated posts ( i.e. includes the "nextpage". Quicktag one or more times ). This tag must be within The Loop.

The defaults for overwriting are: 'next_or_number' - Default is 'number' ( string ). Indicates whether page

 numbers should be used. Valid values are number and next.

'nextpagelink' - Default is 'Next Page' ( string ). Text for link to next page.

 of the bookmark.

'previouspagelink' - Default is 'Previous Page' ( string ). Text for link to

 previous page, if available.

'pagelink' - Default is '%' ( String ).Format string for page numbers. The % in

 the parameter string will be replaced with the page number, so Page %
 generates "Page 1", "Page 2", etc. Defaults to %, just the page number.

'before' - Default is '

Pages:' ( string ). The html

 or text to prepend to each bookmarks.

'after' - Default is '

' ( string ). The html or text to append to each

 bookmarks.

'text_before' - Default is '' ( string ). The text to prepend to each Pages link

 inside the <a> tag. Also prepended to the current item, which is not linked.

'text_after' - Default is '' ( string ). The text to append to each Pages link

 inside the <a> tag. Also appended to the current item, which is not linked.

Arguments

$args

string|array

Optional. Overwrite the defaults.

Response

string

Formatted output in HTML.