Contents
Filters
Just like regular WP filters, Featured Articles filters can be used to modify or replace specific data. The filters above can be used, for example, in your theme functions.php file.
fa_display_dynamic_areas
Runs before displaying the sliders from a dynamic area. Can be used to prevent an area from being displayed entirely.
Parameters
$display_area
(boolean) Displays the area (TRUE) or doesn’t (FALSE).
$area
(string) Name of dynamic area being displayed.
fa_display_slider
Runs before displaying any of the sliders. Can be used to prevent a certain slider ID from being displayed.
Parameters
$display
(boolean) Will show the slider (TRUE) or it will skip it from being displayed (FALSE).
$slider_id
(integer) ID of slider being displayed.
$dynamic_area
(string) Name of dynamic area if slider is set to display automatically or false.
fa_get_slider_options
Filter on currently displayed slider options.
Parameters
$options
(array) Set of options being returned.
$key
(string) The key of the options set from the global options array.
$slider_id
(integer) ID of slider that the options are retrieved for.
fa_get_slide_options
Filter that runs when retrieving options for slides.
Parameters
$options
(array) Slide options array.
$slide_id
(integer) ID of slide.
the_fa_slide_author
Filter the slide author output.
Parameters
$output
(string) The author name output.
$post
(object) Post object for the slide being displayed.
$slider
(object) Post object of slider being displayed.
the_fa_slide_read_more
Filter the read more link for the current slide being displayed in a slider.
Parameters
$output
(string) The read more link output.
$post
(object) Post object for the slide being displayed.
$slider
(object) Post object of slider being displayed.
the_fa_content
Filter on current slide content.
Parameters
$output
(string) The slide content output.
$post
(object) Post object for the slide being displayed.
$slider
(object) Post object of slider being displayed.
the_fa_slide_date
Filter on current slide date.
Parameters
$output
(string) The slide date output.
$post
(object) Post object for the slide being displayed.
$slider
(object) Post object of slider being displayed.
the_fa_slide_title
Filter on current slide title.
Parameters
$output
(string) The slide title output.
$post
(object) Post object for the slide being displayed.
$slider
(object) Post object of slider being displayed.
the_fa_slide_image
Filter on current slide image.
Parameters
$output
(string) The slide image output.
$post
(object) Post object for the slide being displayed.
$slider
(object) Post object of slider being displayed.
the_fa_slider_title
Filter the current slider title.
Parameters
$output
(string) The slider title.
$slider_id
(integer) Slider post ID.
fa_show_slider_edit_link
Filter the slider edit link that is displayed for admins to easily allow them to edit sliders.
Parameters
$show
(boolean) Show the edit link (TRUE) or hide it (FALSE).
$slider_id
(integer) Slider post ID.
Slider themes filters
Following filters are designed to be used only in Featured Articles slider themes functions.php file. By using them, a slider theme can set extra settings for sliders. These settings can be displayed using the actions specific for slider themes.
fa_extra_slider_options
Allows themes to add their own parameters into the slider settings.
Parameters
$option
(array) The existing option where the theme adds its own options. This filter must be used only in slider theme functions.php file.
fa-theme-details-$theme
Allows passing of slider theme details to the plugin. The array passed back to the plugin must have a special structure.
The filter passes as argument the default array that this function must return. This filter must be used only in slider theme functions.php file.
Parameters
$defaults
(array) Array containing the keys that must be filled with the theme details.