DiviArea.addAction()

  1. Home
  2. Knowledge Base
  3. JS API
  4. DiviArea.addAction()
DiviArea.addAction(hook, callback, priority, context)

The JS API uses an action/filter system that is very similar to the WordPress actions/filters. The API fires actions at certain points that you can tap into to provide additional functionality.

The addAction() function registers a callback function that is executed when the specified action is fired.

Params

hook
(string) (Required) Name of the action to observe.
callback
(function) (Required) The callback function to execute when the action is fired. Any return value of the callback function is ignored.
priority
(int) (Optional) Used to specify the order, in which callbacks are executed. Callbacks with a lower priority are called first.
Default value: 10
context
(object) (Optional) Used to define a custom value for the scope-variable this in the callback function.
Default value: window

Returns

The function does not return anything.

Examples

DiviArea.addAction('show_area', function() {
  console.log('An Area is displayed');
});

Notes

To see the exact names and execution order of all the JS API actions and filters on your website, simply enable the Debugging Output, then open your browsers JS console and visit a page with an Area/Popup. Look for the “Apply Filters” and “Do Action” entries:

Sample output in the browsers JS console.

Was this article helpful?

Related Articles