Licensing terms

1. You need to purchase an extended license of the plugin per themes which including the Item.
2. You cannot redistribute the item "as-is", even if you modify it or you make a derivative version for another platform.

Please read the full licenses online on the following links:

• Licensing FAQs
• Extended license

Usage terms

Since the current licenses do not deal with re-selling Items, Envato lets authors to decide whether they grant permission for bundling Items or not. We have the following conditions, and you need to follow them:

1. You cannot offer the plugin as a stand-alone item

   You can't include the plugin separately from your theme in the download package, you have to use the TGM Plugin Activation class. See the "Bundling" section for more information.

2. You cannot provide an Item Purchase Code for your customers

   Since Envato doesn't have a "multi-use" or transferable license, your customers are not entitled to receive an Item Purchase Code with your theme and use the plugin separately from your work.

3. Updating the plugin is your own responsibility

   Since your customers can't receive updates from us, you need to handle this on your own. The TGM Plugin Activation class makes it simple, and we are providing the necessary tools to make it quick as well.

4. You need to handle LayerSlider related support requests after your customers

   We would like to hear your thoughts and suggestions to fix issues and improve our items based on your feedback, but we cannot provide free support for your customers, this is your own responsibility.

5. Use our preferred settings for TGM plugin installation

   With the above mentioned licensing terms you need to configure the plugin in TGM to automatically activate & deactivate it whenever your users are switching themes.

6. You cannot modify the plugin to use it for unintended purposes

   You are not allowed to alter the item in order to unlock premium features or get around safety mechanisms. Modifying the plugin to use it for unintended purposes is strictly prohibited. This includes, but not limited to, faking plugin activation, sharing the template store contents etc.

Bundling in themes

Introduction

As of 9th September 2013, Envato requires authors to load bundled WordPress plugins in themes with the TGM Plugin Activation class. This helps authors to include 3rd party components easily and handle their dependencies and updates automatically.

Setting up TGM Plugin Activation class

• Download the latest version of TGM Plugin Activation class from their website.
• Select the appropriate options in their download generator and make sure to choose the "ThemeForest" option in the distribution section.
• After the download, you should visit their Installation and Configuration pages for more information about using TGMPA.
• There is also a working example in the downloaded package.
• Check their FAQ if you have further questions.

Example TGM plugin parameters

Below you can see an example configuration for LayerSlider. You can copy and paste this code, however, make sure to change the source and version properties to the correct values.

// LayerSlider config
array(
	'name' 					=> 'LayerSlider WP',
	'slug' 					=> 'layerslider',
	'source' 				=> get_stylesheet_directory() . '/plugins/layerslider.zip',
	'required' 				=> false,
	'version' 				=> '6.0.0',
	'force_activation' 		=> true,
	'force_deactivation' 	=> true,
	'external_url' 			=> 'https://layerslider.kreaturamedia.com/'
)

Disabling the auto-update feature

We highly recommend you to disable the automatic updates feature, since it requires a valid Item Purchase Code for LayerSlider that your customers won't have. To do that, you can use the layerslider_ready action hook to override the corresponding global variable as it can be seen in the example below.

<?php

// Register your custom function to override some LayerSlider data
add_action('layerslider_ready', 'my_layerslider_overrides');
function my_layerslider_overrides() {

	// Disable auto-updates
	$GLOBALS['lsAutoUpdateBox'] = false;
}
?>

Constants & variables

This section lists and describes the constants and global variables of LayerSlider, which can be useful for writing custom code, improving theme integration and making custom solutions built on top of LayerSlider.

List of plugin constants

List of global variables

Working with sliders

We have a new static class that you can use comfortably to work with sliders. Our older functions for this purpose are still available, but we might remove them in future versions, and we highly recommend you to use the new solution.

Class methods

• (array) LS_Sliders::find( [mixed $filters] )

  Finds sliders with the provided filters and settings. See also the corresponding section below on this page for more information and examples. Accepts:

  • (int) ID of a slider,
  • (string) Slug of a slider,
  • (array) Array of slider IDs as integers
  • (array) The filter object, see below on this page
• (int) LS_Sliders::count( void )

  Returns the total number of found sliders from the latest query with ignoring pagination settings.

• (int) LS_Sliders::add( [string $title = 'Unnamed' [, array $data = array() [, string $slug = '' ]]] )

  Adds a new slider with the provided settings and slug. All parameters are optional. The plugin will use the default slider settings if you provide partial/empty slider data.

• (bool) LS_Sliders::remove( int $ID )

  Removes a slider by its database ID. Returns a boolean value to indicate success or failure. This method preserves the actual data in DB to restore it later.

• (bool) LS_Sliders::delete( int $ID )

  Permanently deletes a slider by its database ID. Returns a boolean value to indicate success or failure.

• (bool) LS_Sliders::restore( int $ID )

  Restores a previously removed slider by its database ID. Returns a boolean value to indicate success or failure.

LS_Sliders filter object

Examples

Find a slider by its database ID.

$sliders = LS_Sliders::find(2);

Find a slider by its slug.

$sliders = LS_Sliders::find('fullwidthdemo');

Find multiple sliders by their IDs.

$sliders = LS_Sliders::find(array(12, 15, 23));

Find sliders with custom filters and return results with modifiers.

$sliders = LS_Sliders::find(array(
	'orderby' => 'date_m',
	'limit' => 30,
	'data' => false
));

Returning slider objects

Working with sources

{
	"name": "Borderless Dark for 3D sliders",
	"version": "4.6.0",
	"requires": "4.5.5",
	"author": "Kreatura Media",
	"created": "2013-01-15",
	"updated": "2013-07-29",
	"note": ""
}

{
	"name": "Full width demo slider",
	"version": "5.3.0",
	"requires": "5.1.0",
	"author": "Kreatura Media",
	"url": "preview web address"
	"groups": "bundled,free"
	"created": "2013-12-23",
	"updated": "2013-12-23",
	"note": ""
}

Action hooks

Public action hooks reference

Read the WP Codex entry for more information about using actions.

Actions hook examples

The following example uses the layerslider_installed action to add demo content when the plugin was installed for the first time.

<?php

add_filter('layerslider_installed', 'my_layerslider_demos');
function my_layerslider_demos() {

	// Method 1: Using importUtil
	include LS_ROOT_PATH.'/classes/class.ls.importutil.php';
	$import = new LS_ImportUtil('<path_to_your_export_file>');

	// Method 2: Using LS_Sliders::add()
	LS_Sliders::add($title, $dataArray);
}

?>

This example uses the layerslider_before_slider_content and layerslider_after_slider_content actions to print out a custom slider wrapper.

<?php

add_filter('layerslider_before_slider_content', 'my_ls_before_content');
add_filter('layerslider_after_slider_content', 'my_ls_after_content');

function my_ls_before_content() {
	echo '<div class="my-layerslider-wrapper">';
}

function my_ls_after_content() {
	echo '</div>';
}

?>

Filter hooks

Public filter reference

Read the WP Codex entry for more information about using filters.

Filter hook examples

The following example uses the layerslider_override_defaults filter to change some default settings related to appearance.

<?php

add_filter('layerslider_override_defaults', 'my_override');
function my_override($defaults) {

	// Uncomment these to see all settings
	// echo '<pre>';
	// var_dump($defaults);
	// echo '</pre>';

	// Override some defaults
	$defaults['slider']['fullWidth']['value'] = true;
	$defaults['slider']['skin']['value'] = 'myskin';

	return $defaults;
}

?>

Another example of using the layerslider_override_defaults filter to apply the same transition on slides by default.

<?php

add_filter('layerslider_override_defaults', 'my_override');
function my_override($defaults) {

	$defaults['slides']['2dTransitions']['value'] = '5';

	return $defaults;
}

?>

Release log

Changes in LayerSlider 6.4.0

• Added layerslider_slider_init filter hook to provide an option to change the JavaScript slider initialization code.
• Added additional parameters to layerslider_slider_markup filter hook to provide context with more information about the affected slider.

Changes in LayerSlider 6.2.0

• Added layerslider_root_url filter to override paths in case the plugin is loaded externally from a custom location. See Filter Reference to learn more.

Changes in LayerSlider 6.0.0

• Updated the Bundling in themes section
• The layerslider database table will now be created on the fly to provide better support for multisite installations. Make sure to use one of the actions hooks to execute your install/update code, as the DB table may not be accessible at any time.
• Bundled demo sliders can now be tagged to work with our new Import Templates modal window. Read the updates Working with sliders section.
• Make sure to read the End-User documentation as well, since version 6.0.0 has countless new features, improvements and other changes.

Changes in previous versions

Version 5.6.2

• The layerslider_slider_markup filter hook no longer contains the JS init code

Version 5.6.0

• Fixed the layerslider_slider_markup filter hook

Version 5.5.0

• Added a new section for listing constants and global variables used by LayerSlider.
• Improved some example codes

Version 5.4.0

• Added filter to override the slider markup before output

Version 5.3.2

• LS_Sliders::add() now accepts a 3rd parameter to set the slider slug
• Slider slugs are now added properly after importing

Version 5.3.1

• Fixed LS_Sources::urlForSkin() returning invalid URLs on certain installations.
• Dropped multibyte functions in LS_Sources methods, using strtolower() to have lowercase handles instead. The result may vary depending on the server locale.

Version 5.3.0

• Added LS_Sources class to load skins and demo sliders externally.
• The LayerSlider shortcode is now registered globally, thus page builder solutions can pick it up automatically.
• Added new API method 'redraw' to update the slider's layout and contents.

Version 5.2.0

• From now on automatic updates can be enabled on two websites at the same time with a purchase code
• Disabling the auto-update in themes now only warns the users about the feature requirements instead of hiding the box

Version 5.1.0

• Read the release log in the regular docs
• Updated documentation with fixes and extended content
• Changed import/export method, affects samples
• LS_Sliders::find() now accepts slider slug
• LS_Sliders::find() now accepts slider array of IDs
• Fixed $title param of LS_Sliders::add()
• Updated layerslider database table
• Fixed detecting version changes and running upgrade scripts

Version 5.0.x

• Read through all the new docs (including the one for End-Users). Version 5.0.0 has major changes under the hood.
• Old slide & layer transitions are deprecated. They will still work on front-end pages, but might be dropped completely in future versions. You should take this under consideration when changing the defaults.
• Some of the new APIs are still experimental and will likely change. Use them for your own risk.

Major changes till 6.0.0

• Using the Options API for storing sliders is deprecated since v3.6.0, and backwards compatibility will be dropped in the near future.