Properties

$fullpage

$fullpage : array

The FUllpage.

Type

array

$sections

$sections : array

List of sections.

Type

array

$section

$section : array

The current section.

Type

array

$slide

$slide : array

The current slide.

Type

array

$section_count

$section_count : integer

The amount of sections for the current fullpage.

Type

integer

$current_section

$current_section : integer

Index of the current section in the loop.

Type

integer

$in_the_section_loop

$in_the_section_loop : boolean

Whether the section loop has started and the caller is in the loop.

Type

boolean

$_instance

$_instance : \WP_Fullpage_Query

Type

\WP_Fullpage_Query — The single instance of the class

Methods

instance()

instance() : \WP_Fullpage_Query

Main WP_Fullpage_Query Instance

Ensures only one instance of WP_Fullpage_Query is loaded or can be loaded.

Returns

\WP_Fullpage_Query

Main instance

__construct()

__construct() 

Construct the Class object

next_section()

next_section() : \WP_Post

Set up the next section and iterate current section index.

Returns

\WP_Post —

Next section.

next_slide()

next_slide() : \WP_Post

Set up the next slide and iterate current slide index.

Returns

\WP_Post —

Next slide.

the_section()

the_section() : void

Sets up the current section.

Retrieves the next section, sets up the section, sets the 'in the section loop' property to true.

the_slide()

the_slide() : void

Sets up the current slide.

Retrieves the next slide, sets up the slide, sets the 'in the slide loop' property to true.

have_sections()

have_sections() : boolean

Whether there are more sections available in the loop.

Calls action 'sections_loop_end', when the loop is complete.

Returns

boolean —

True if sections are available, false if end of loop.

have_slides()

have_slides() : boolean

Whether there are more slides available in the loop.

Calls action 'slides_loop_end', when the loop is complete.

Returns

boolean —

True if slides are available, false if end of loop.

rewind_sections()

rewind_sections() : void

Rewind the sections and reset section index.

rewind_slides()

rewind_slides(  $section_index = null) : void

Rewind the slides and reset slide index.

Parameters

$section_index

get_fullpage_ID()

get_fullpage_ID(boolean  $print = false) : integer

Display or retrieve the ID of the current fullpage in the fullpage Loop.

Parameters

boolean $print

Optional, default to false. Whether to display or return.

Returns

integer —

the ID of the current fullpage

get_section_ID()

get_section_ID(integer  $section_index = -1, boolean  $print = false) : integer

Display or retrieve the ID of the section in the fullpage Loop.

Parameters

integer $section_index

Optional. The section index. If empty, will take the current section.

boolean $print

Optional, default to false. Whether to display or return.

Returns

integer —

the ID of the section

get_slide_ID()

get_slide_ID(integer  $section_index = -1, integer  $slide_index = -1, boolean  $print = false) : integer

Display or retrieve the ID of the slide in the section Loop.

Parameters

integer $section_index

Optional. The section index. If empty, will take the current section.

integer $slide_index

Optional. The slide index. If empty, will take the current slide.

boolean $print

Optional, default to false. Whether to display or return.

Returns

integer —

the ID of the slide

get_fullpage_title()

get_fullpage_title(integer  $fullpage_ID, string  $before = '', string  $after = '', boolean  $print = true) : null|string

Display or retrieve the fullpage title with optional content.

Parameters

integer $fullpage_ID

Optional. The fullpage ID. If empty, will take the current fullpae.

string $before

Optional. Content to prepend to the title.

string $after

Optional. Content to append to the title.

boolean $print

Optional, default to true. Whether to display or return.

Returns

null|string —

Null on no title. String if $print parameter is false.

get_section_title()

get_section_title(integer  $section_ID, string  $before = '', string  $after = '', boolean  $print = true) : null|string

Display or retrieve the section title with optional content.

Parameters

integer $section_ID

Optional. The section ID. If empty, will take the current section.

string $before

Optional. Content to prepend to the title.

string $after

Optional. Content to append to the title.

boolean $print

Optional, default to true. Whether to display or return.

Returns

null|string —

Null on no title. String if $print parameter is false.

get_slide_title()

get_slide_title(integer  $slide_ID, string  $before = '', string  $after = '', boolean  $print = true) : null|string

Display or retrieve the slide title with optional content.

Parameters

integer $slide_ID

Optional. The slide ID. If empty, will take the current slide.

string $before

Optional. Content to prepend to the title.

string $after

Optional. Content to append to the title.

boolean $print

Optional, default to true. Whether to display or return.

Returns

null|string —

Null on no title. String if $print parameter is false.

get_title()

get_title(integer  $post_ID, string  $before = '', string  $after = '') : null|string

Retrieve the post title with optional content.

Parameters

integer $post_ID

The post ID.

string $before

Optional. Content to prepend to the title.

string $after

Optional. Content to append to the title.

Returns

null|string —

Null on $post_ID empty or no title. String else.

get_fullpage_date()

get_fullpage_date(integer  $fullpage_ID, string  $d = '', boolean  $print = true) : string

Display or retrieve the date on which the fullpage was written.

Parameters

integer $fullpage_ID

Optional. The fullpage ID. If empty, will take the current fullpage.

string $d

Optional. PHP date format defaults to the date_format option if not specified.

boolean $print

Optional, default to true. Whether to display or return.

Returns

string

get_section_date()

get_section_date(integer  $section_ID, string  $d = '', boolean  $print = true) : string

Display or retrieve the date on which the section was written.

Parameters

integer $section_ID

Optional. The section ID. If empty, will take the current section.

string $d

Optional. PHP date format defaults to the date_format option if not specified.

boolean $print

Optional, default to true. Whether to display or return.

Returns

string

get_slide_date()

get_slide_date(integer  $slide_ID, string  $d = '', boolean  $print = true) : string

Display or retrieve the date on which the slide was written.

Parameters

integer $slide_ID

Optional. The slide ID. If empty, will take the current slide.

string $d

Optional. PHP date format defaults to the date_format option if not specified.

boolean $print

Optional, default to true. Whether to display or return.

Returns

string

get_the_date()

get_the_date(integer  $post_ID, string  $d = '') : string

Retrieve the date on which the post was written.

Modify output with 'get_the_date' filter.

Parameters

integer $post_ID

Post ID

string $d

Optional. PHP date format defaults to the date_format option if not specified.

Returns

string —

Date the current post was written.

get_fullpage_author()

get_fullpage_author(integer  $fullpage_ID, boolean  $print = true) : string

Display or retrieve the author of the fullpage.

Parameters

integer $fullpage_ID

Optional. The fullpage ID. If empty, will take the current fullpage.

boolean $print

Optional, default to true. Whether to display or return.

Returns

string

get_section_author()

get_section_author(integer  $section_ID, boolean  $print = true) : string

Display or retrieve the author of the section.

Parameters

integer $section_ID

Optional. The section ID. If empty, will take the current section.

boolean $print

Optional, default to true. Whether to display or return.

Returns

string

get_slide_author()

get_slide_author(integer  $slide_ID, boolean  $print = true) : string

Display or retrieve the author of the slide.

Parameters

integer $slide_ID

Optional. The slide ID. If empty, will take the current slide.

boolean $print

Optional, default to true. Whether to display or return.

Returns

string

get_the_author()

get_the_author(integer  $post_ID) : string

Retrieve the author of the post.

Parameters

integer $post_ID

The post ID.

Returns

string

fullpage_has_full_navigation()

fullpage_has_full_navigation() : boolean

Do the fullpage has a full navigation?

Returns

boolean

section_has_slides_navigation()

section_has_slides_navigation(integer  $section_index = -1) : boolean

Do the section has a slides navigation?

Parameters

integer $section_index

Optional. The section index. If empty, will take the current section.

Returns

boolean

get_slides_navigation_position()

get_slides_navigation_position(integer  $section_index = -1, boolean  $print = true) : string

Display or retrieve slides navigation position for a section.

Parameters

integer $section_index

Optional. The section index. If empty, will take the current section.

boolean $print

Optional, default to true. Whether to display or return.

Returns

string —

the position of slides navigation

get_section_nav_title()

get_section_nav_title(integer  $section_index = -1, boolean  $print = false) : null|string

Display or retrieve the section navigation title.

Parameters

integer $section_index

Optional. The section index. If empty, will take the current section.

boolean $print

Optional, default to false. Whether to display or return.

Returns

null|string —

Null on no title. String if $print parameter is false.

get_slide_nav_title()

get_slide_nav_title(integer  $section_index = -1, integer  $slide_index = -1, boolean  $print = false) : null|string

Display or retrieve the slide navigation title.

Parameters

integer $section_index

Optional. The section index. If empty, will take the current section.

integer $slide_index

Optional. The slide index. If empty, will take the current slide.

boolean $print

Optional, default to false. Whether to display or return.

Returns

null|string —

Null on no title. String if $print parameter is false.

get_slide_position()

get_slide_position(integer  $section_index = -1, integer  $slide_index = -1, boolean  $print = true) : string

Display or retrieve the slide navigation position.

Parameters

integer $section_index

Optional. The section index. If empty, will take the current section.

integer $slide_index

Optional. The slide index. If empty, will take the current slide.

boolean $print

Optional, default to true. Whether to display or return.

Returns

string —

could be something like 'top center', 'middle left', ...

get_content_margin()

get_content_margin(integer  $section_index = -1, integer  $slide_index = -1, boolean  $print = true) : string

Display or retrieve the slide content margin.

Parameters

integer $section_index

Optional. The section index. If empty, will take the current section.

integer $slide_index

Optional. The slide index. If empty, will take the current slide.

boolean $print

Optional, default to true. Whether to display or return.

Returns

string

get_slide_color()

get_slide_color(integer  $section_index = -1, integer  $slide_index = -1, boolean  $print = true) : string

Display or retrieve the slide color.

Parameters

integer $section_index

Optional. The section index. If empty, will take the current section.

integer $slide_index

Optional. The section index. If empty, will take the current slide.

boolean $print

Optional, default to true. Whether to display or return.

Returns

string

get_fullpage_easing()

get_fullpage_easing(boolean  $print = true) : string

Display or retrieve the fullpage easing.

Only work if css3 is activated. Returns empty string if not.

Parameters

boolean $print

Optional, default to true. Whether to display or return.

Returns

string

get_section_easing()

get_section_easing(integer  $section_index = -1, boolean  $print = true) : string

Display or retrieve the section easing.

Only work if css3 is activated. Returns empty string if not.

Parameters

integer $section_index

Optional. The section index. If empty, will take the current section.

boolean $print

Optional, default to true. Whether to display or return.

Returns

string

display_section_title()

display_section_title(integer  $section_index = -1, integer  $slide_index = -1) : boolean

Display section title within slide?

Parameters

integer $section_index

Optional. The section index. If empty, will take the current section.

integer $slide_index

Optional. The slide index. If empty, will take the current slide.

Returns

boolean

display_title()

display_title(integer  $section_index = -1, integer  $slide_index = -1) : boolean

Display post title within slide?

Parameters

integer $section_index

Optional. The section index. If empty, will take the current section.

integer $slide_index

Optional. The slide index. If empty, will take the current slide.

Returns

boolean

display_date()

display_date(integer  $section_index = -1, integer  $slide_index = -1) : boolean

Display post date within slide?

Parameters

integer $section_index

Optional. The section index. If empty, will take the current section.

integer $slide_index

Optional. The slide index. If empty, will take the current slide.

Returns

boolean

display_author()

display_author(integer  $section_index = -1, integer  $slide_index = -1) : boolean

Display post author within slide?

Parameters

integer $section_index

Optional. The section index. If empty, will take the current section.

integer $slide_index

Optional. The slide index. If empty, will take the current slide.

Returns

boolean

auto_height()

auto_height(integer  $section_index = -1, boolean  $print = true) : string

Display or retrieve the auto height class.

Returns empty string if not.

Parameters

integer $section_index

Optional. The section index. If empty, will take the current section.

boolean $print

Optional, default to true. Whether to display or return.

Returns

string

get_fullpage_guid()

get_fullpage_guid(integer  $fullpage_ID, boolean  $print = false) : string

Display or retrieve the fullpage Unique Identifier (guid).

The guid will appear to be a link, but should not be used as an link to the post. The reason you should not use it as a link, is because of moving the blog across domains.

Url is escaped to make it xml safe if displayed

Parameters

integer $fullpage_ID

Optional. The fullpage ID. If empty, will take the current fullpae.

boolean $print

Optional, default to false. Whether to display or return.

Returns

string

get_section_guid()

get_section_guid(integer  $section_ID, boolean  $print = false) : string

Display or retrieve the section Unique Identifier (guid).

The guid will appear to be a link, but should not be used as an link to the post. The reason you should not use it as a link, is because of moving the blog across domains.

Url is escaped to make it xml safe if displayed

Parameters

integer $section_ID

Optional. The section ID. If empty, will take the current section.

boolean $print

Optional, default to false. Whether to display or return.

Returns

string

get_slide_guid()

get_slide_guid(integer  $slide_ID, boolean  $print = false) : string

Display or retrieve the slide Unique Identifier (guid).

The guid will appear to be a link, but should not be used as an link to the post. The reason you should not use it as a link, is because of moving the blog across domains.

Url is escaped to make it xml safe if displayed

Parameters

integer $slide_ID

Optional. The slide ID. If empty, will take the current slide

boolean $print

Optional, default to false. Whether to display or return.

Returns

string

get_fullpage_bg()

get_fullpage_bg(integer  $fullpage_ID, boolean  $print = false, string  $size = 'full') : string

Display or retrieve the fullpage background.

Parameters

integer $fullpage_ID

Optional. The fullpage ID. If empty, will take the current fullpage.

boolean $print

Optional, default to false. Whether to display or return.

string $size

Optional, default to 'full'.

Returns

string

get_section_bg()

get_section_bg(integer  $section_ID, boolean  $print = false, string  $size = 'full') : string

Display or retrieve the section background.

Parameters

integer $section_ID

Optional. The section ID. If empty, will take the current section.

boolean $print

Optional, default to false. Whether to display or return.

string $size

Optional, default to 'full'.

Returns

string

get_slide_bg()

get_slide_bg(integer  $slide_ID, boolean  $print = false, string  $size = 'full') : string

Display or retrieve the slide background.

Parameters

integer $slide_ID

Optional. The slide ID. If empty, will take the current slide.

boolean $print

Optional, default to false. Whether to display or return.

string $size

Optional, default to 'full'.

Returns

string

get_bg()

get_bg(integer  $post_ID, string  $size = 'full') : string

Retrieve the post background.

Parameters

integer $post_ID

The post ID.

string $size

Optional, default to 'full'.

Returns

string

get_fullpage_option()

get_fullpage_option(string  $option_name, string  $default_value) : string

Retrieve fullpage option.

Parameters

string $option_name
string $default_value

Returns

string

get_section_option()

get_section_option(integer  $section_index, string  $option_name, string  $default_value) : string

Retrieve section option.

Parameters

integer $section_index

The section index. If empty, will take the current section.

string $option_name
string $default_value

Returns

string

get_slide_option()

get_slide_option(integer  $section_index, integer  $slide_index, string  $option_name, string  $default_value) : string

Retrieve slide option.

Parameters

integer $section_index

The section index. If empty, will take the current section.

integer $slide_index

The slide index. If empty, will take the current slide.

string $option_name
string $default_value

Returns

string

get_dynamic_slide_style()

get_dynamic_slide_style(integer  $section_index = -1, integer  $slide_index = -1) : void

Retrieve the dynamic slide style.

Parameters

integer $section_index

Optional. The section index. If empty, will take the current section.

integer $slide_index

Optional. The slide index. If empty, will take the current slide.

get_dynamic_fullpage_style()

get_dynamic_fullpage_style() : void

Retrieve the dynamic Navigation and sections navigation style.

get_dynamic_section_style()

get_dynamic_section_style(integer  $section_index = -1) : void

Retrieve the dynamic Section style.

Parameters

integer $section_index

Optional. The section index. If empty, will take the current section.

get_content()

get_content(integer  $section_index = -1, integer  $slide_index = -1, boolean  $print = true, string  $more_link_text = null, boolean  $strip_teaser = false) : string

Display or retrieve the slide content of the slide.

Parameters

integer $section_index

Optional. The section index. If empty, will take the current section.

integer $slide_index

Optional. The section index. If empty, will take the current slide.

boolean $print

Optional, default to true. Whether to display or return.

string $more_link_text

Optional. Content for when there is more text.

boolean $strip_teaser

Optional. Strip teaser content before the more text. Default is false.

Returns

string

init_fullpage()

init_fullpage() : void

Init the Fullpage

init_sections()

init_sections() : void

Init the Sections

init_slides()

init_slides(integer  $section_index) : void

Init the Slides

Parameters

integer $section_index