Ajax Search Pro Documentation
Get Ajax Search Pro!Get SupportKnowledge BaseDevelopment
  • Ajax Search Pro Documentation
  • GDPR and Cookie policy
  • Video Guides
  • Plugin Updates
    • Automatic Updates
      • Activation on Development and Staging environments
      • Managing purchase codes
      • Purchase Code (license key)
    • Manual Updates
    • Safe Update Guide
    • Plugin update issues or errors
    • Disabling update check
  • Installation instructions
    • Uninstallation & Reset
  • Getting started
    • Importing from the Lite version
    • Editor Blocks
    • Search Shortcodes
    • Search Widget
    • Gutenberg and Other Page Editors
    • Replacing the default theme search bar
    • Placing the search shortcode in theme files
    • Search as menu item
    • Custom result box position
    • Custom filters box position
    • Shortcode generator
  • Search Sources
    • Search Engine
    • Post, Page, Product and other Post Type Search
    • Searching Titles, Content, Excerpt
    • Search in custom fields
      • Search By Product SKU
    • Search by categories, tags or other terms
    • Search in Attachments
      • Mime types table
    • Search in File contents (pdf, word, excel etc..)
    • Search in Users
      • User meta fields
    • Limits (number of results)
    • Categories and terms as results
    • Image options
    • Result ordering
    • Peepso Groups & Group activities search
    • Grouping title duplicates
  • Behavior
    • Return/Enter key and Magnifier icon click actions
    • Search logic (primary and secondary)
      • Exact Matches vs Fuzzy Matches
      • Search logics explained
    • Live search triggering events
    • Results page override
    • Results, Archive Page and Shop Live Search and Filter
  • Elementor Integration
    • Elementor Pro Posts Widget Live Filter
    • Elementor Loop Grid Integration
    • Elementor Pro Product Widget Live Filter
    • Custom results page with Elementor Pro
    • Elementor custom search page archive override and live filter
  • Other Integration
    • Jet Engine Listing Grid Integration
  • Multisite Settings
  • Frontend Search Settings & Search Filters
    • Settings layout, position and visibility
    • Generic Selectors
    • Content Type filters
    • Date filters
    • Category and Taxponomy term filters
    • Post type Filters
    • Custom field filters - selectors
    • Search button
    • Reset button
  • Layout Settings
    • Result Layout Types
    • Results information box
    • Results position & snap
    • Content, author, date and description in results
    • More results loader and infinite scroll feature
    • Results behavior
    • Results text keyword highlighter
    • Compact search box layout
    • Auto Populate - Automatic search results on initial page load
  • Autocomplete and Keyword suggestions
    • Autocomplete
    • Results and Keyword suggestions
    • "Try these" - suggested phrases
  • Theme Options - Visual changes to the search bar
    • Theme chooser
    • Preview
    • Search box and input field layout
    • Settings and Magnifier icon
    • Settings dropdown
    • Typography
  • Index Table
    • Generating the index table
    • Enabling index table engine
    • File Content Search Addon
    • Index table FAQ
    • Synonyms
  • Relevance Options
  • Advanced Options and Uses
    • Using the Results shortcode as a custom results page
    • Shortcodes in results content
    • HTML tags in results
    • Primary and Secondary title and description fields
    • Advanced title and Content fields
      • User Search - Advanced Title and Content fields
    • Excluding & Including results
      • Exclude by category or terms
      • Exclude or Include by authors (users)
      • Exclude or Include by date
      • Exclude by Item or ID
      • Include by ID
      • Include by categories or terms (restrict to category)
      • Exclude or Include by custom field values
    • Grouping results
    • Keyword Exception & Exclusions
  • Result priority settings
    • Individual Priorities
    • Priorities by Rules (priority groups)
  • Performance Tuning
    • Fine tuning the search configuration
    • Cache
    • Visual performance
    • Ajax performance tracker
  • Compatibility Settings
    • Javascript Compatibility
  • Google Analytics Integration (GA4)
    • Tracking with Google Site Tag (gtag.js)
    • Tracking with Google Tag Manager
    • Site Search Tracking
  • Troubleshooting
    • Styling issues
    • The response data is missing from the ajax request error message
  • Translating components
    • Translating with WPML
    • Translating with Polylang
  • Pre-Purchase FAQ
  • Plugin API
    • Actions list and usage
    • Filters list and usage
    • asp_query_args filter
    • Theme functions
    • Front-end filters API
    • Javascript API
  • Other Useful Things
    • Additional search keywords for post types
    • Negative keywords
    • Meta box on post editor screen
Powered by GitBook
On this page
  • Usage examples
  • Action hook list
  1. Plugin API

Actions list and usage

Actions are triggered by specific events that take place in the plugin code.

Usage examples

/**
 * Example 1
 *
 * This function will save the search phrase to the database
 */
add_action( 'asp_before_search', 'asp_change_phrase', 10, 1);

function asp_change_phrase( $phrase ) {
  update_option('asp_search_phrase', $phrase);
}

/**
 * Example 2
 * 
 * This function will print "Hi!" header before the search shortcode. 
 */
add_action( 'asp_layout_before_shortcode', 'asp_print_before_shortcode');

function asp_print_before_shortcode() {
  echo "<h3>Hi!</h3>";
}

Action hook list

/**
 * Functional actions 
 * 
 * Variables:
 *      $id -> the ID of the search instance
 *      $search_phrase -> holds the search phrase
 *      $results_assoc_array -> an associated array of all result objects
 *      $pageposts_assoc_array -> an associated array of posts, pages, custom post types results
 *      $commentsresults_assoc_array -> an associated array of comment results
 *      $buddypresults_assoc_array -> an associated array of buddypress results
 */

do_action('asp_before_search', $search_phrase); 
do_action('asp_after_search', $search_phrase, $results_assoc_array);

do_action('asp_after_pagepost_results', $search_phrase, $pageposts_assoc_array);
do_action('asp_after_comments_results', $search_phrase, $commentsresults_assoc_array);
do_action('asp_after_buddypress_results', $search_phrase, $buddypresults_assoc_array);

do_action('asp_before_autocomplete', $search_phrase);
do_action('asp_after_autocomplete', $search_phrase, $keyword);

/* Box, Settings etc.. layount actions */

do_action('asp_layout_before_shortcode', $id);
do_action('asp_layout_after_shortcode', $id);
do_action('asp_layout_before_input', $id);
do_action('asp_layout_after_input', $id);
do_action('asp_layout_before_magnifier', $id);
do_action('asp_layout_in_magnifier', $id);
do_action('asp_layout_after_magnifier', $id);
do_action('asp_layout_before_settings', $id);
do_action('asp_layout_after_settings', $id);
do_action('asp_layout_before_loading', $id);
do_action('asp_layout_in_loading', $id);
do_action('asp_layout_after_loading', $id);
do_action('asp_layout_settings_before_first_item', $id);

/* Template related actions */

// Vertical layout
do_action('asp_res_vertical_begin_item');
do_action('asp_res_vertical_before_image');
do_action('asp_res_vertical_after_image');
do_action('asp_res_vertical_after_content');
do_action('asp_res_vertical_end_item');

// Horizontal layout
do_action('asp_res_horizontal_begin_item');
do_action('asp_res_horizontal_after_image');
do_action('asp_res_horizontal_after_content');
do_action('asp_res_horizontal_end_item');

// Isotopic layout
do_action('asp_res_isotopic_begin_item');
do_action('asp_res_isotopic_after_image');
do_action('asp_res_isotopic_after_content');
do_action('asp_res_isotopic_end_item');
PreviousPlugin APINextFilters list and usage

Last updated 7 years ago

More examples in the

If you need more general information about hooks in WordPress, please check their

knowledge base.
plugin API reference.