Search Results

Action and Filter Reference

The JS API uses a hook-system that is very similar to the WordPress PHP actions and filters. To learn more about hooking into those events,…

How To Determine Current Action Name and Priority

We all know how to attach a custom callback function to a WordPress action.But what happens, when you have multiple actions run the same function?…

DiviArea.addFilter()

Register a callback function for a certain JS filter

DiviArea.addAction()

Register a callback function for a certain JS action

DiviAreaItem.applyFilters()

Runs a JS filter via DiviArea.applyFilters() with the given hook name. This function will call two filters: One exactly as specified in the hook, and…

DiviAreaItem.doAction()

Runs a JS action via DiviArea.doAction() with the given hook name. This function will call two hooks: One exactly as specified in the hook, and…

DiviArea.applyFilters()

Applies all previously registered filter hooks and returns the filtered value. Params Returns Returns the filtered value. Notes No notes

DiviAreaItem.addFilter()

Register a new hook that only handles filters of this Area

applyFilters( “area_trigger_conditions” )

Allows to add custom Area conditions right before an Area is triggered

applyFilters( “area_preparation_time” )

Filter the default detach delay when creating a new Area.

DiviArea.removeFilter()

Removes a previously registered filter hook.

applyFilters( “area_general_conditions” )

Allows to add custom Area conditions right after the page loaded

doAction( “close_area” )

Fired internally by the API to process a stoppable close-request

applyFilters( “set_data_expire” )

Filters the lifespan of a local data entry

applyFilters( “reorder_areas” )

Filters the new z-index of all visible areas.

DiviAreaItem.addAction()

Register a new hook that only listens to actions of this Area

applyFilters( “ignore_close_area” )

Allows to ignore the "close_area" request and force an area to stay open

applyFilters( “set_data” )

Filters a value that will be written to a Cookie or the localStorage.

doAction( “area_close_button” )

Allows customization of the default close button

doAction( “position_area” )

Action to modify the Area position on the screen.