Filters

Developer documentation for the Ajax Load More Filters add-on.


Filter Hooks

The following filter hooks are available when using this add-on:

alm_filters_{id}_{key}

Allows developers to take complete control by customizing the returned filter selections for a specific filter key.

  • id: The unique filter ID.
  • key: The target query parameter (key)
    When filtering by custom field or taxonomy, the key parameter must be the meta_key or taxonomy slug value.

The following code snippet returns custom filter values ordered by name in ascending order for the category (key) query of the blog (id) filter.

Note: When using this filter you must return both a label and value in the array.

alm_filters_{id}_{key}_default

This filter will set a default fallback value for a filter block.

  • id: The unique filter ID.
  • key: The target query parameter (key).
    When filtering by custom field or taxonomy, the key parameter must be the meta_key or taxonomy slug value.

The following code snippet will set work, post as fallback post_type value when zero items are selected for the search filter group.

Note: Return values in this hook should (in most cases) directly relate to values already set in the core Ajax Load More shortcode.

alm_filters_{id}_{key}_selected

This filter will set a default pre-selected value for a filter block and is available for the radio, checkbox and select field types only.

  • id: The unique filter ID.
  • key: The target query parameter (key).
    When filtering by custom field or taxonomy, the key parameter must be the meta_key or taxonomy slug value.

The following code snippet will set design as the pre-selected category value of the portfolio filter group.

Note: When using this filter you must also set this value in your core Ajax Load More shortcode.

alm_filters_select_class

Adds custom classes to select element wrappers. This is useful for users who are using select replacement techniques.

alm_filters_button_text

Set a default value of submit button label.

alm_filters_title_element

Update the default HTML of each filter title element.

alm_filters_edit

Disable the filter edit button for logged in (admin) users.


Callback Functions

Each Javascript callback function is dispatched directly from core Ajax Load More Filters and allow you to trigger custom functions based on events during the filter process – to utilize the following callback functions, copy and paste a code example below into your sites JavaScript file.

almFiltersActive

The almFiltersActive() function is dispatched after a filter submit action and returns an object containing the key/value pair combinations of active filters.

almFiltersChange()

The almFiltersChange() function is dispatched when a filter change event is triggered.

almFiltersComplete()

The almFiltersComplete() function is dispatched after the filter process has completed.

almFiltersURLUpdate()

The almFiltersURLUpdate() function is dispatched after the browser URL has been updated.


Public JS Functions

The following JavaScript functions are available when using this add-on:

almFiltersClear()

The almFiltersClear() function will clear and reset an Ajax Load More filter instance.


FAQs

Below are common questions regarding the Filters add-on. If you have a question and don’t see an answer here, please visit the support page and submit your request.

What form field types are currently supported?

Filters can be rendered to screen using any of the following form element styles:

  • Checkbox
  • Radio
  • Select & Multi-Select
  • Text Input

What type of content can I build filters for?

You can create filters based on any of the following WordPress query parameters:

  • Post Type
  • Category
  • Tags
  • Taxonomy
  • Ordering (order, orderby, sort)
  • Search
  • Custom Fields (Meta Query)
  • Authors
  • Date (year, month, day)

Note: Each supported query parameter directly relates to an Ajax Load More shortcode parameter.

How are filters saved in the WordPress admin?

When a filter is saved or modified it is stored as an option in the WordPress Options table.

Can a deleted filter be recovered?

No, once a filter has been deleted it is gone for good.

Select2 change events are not working on select elements, how can I fix this?

If you are using Select2 on elements inside filters you will need to manually dispatch change events so the Filters add-on can respond to the event.


« Back to Add-ons