Ajax Search Pro Knowledge Base
Buy Ajax Search Pro!DocumentationGet SupportDevelopment
  • Knowledge Base
  • Safe Coding Guideline
  • Hooks
    • Filters
      • Query & Output
        • asp_query_args
        • asp_query_{type}
        • asp_cached_content
        • asp_pre_get_front_filters
        • asp_before_ajax_output
        • asp_shortcode_output
        • asp_print_search_query
      • Keyword Suggestions
      • Search Results
        • asp_suggested_phrases
        • asp_results
        • asp_cpt_results
        • asp_buddyp_results
        • asp_attachment_results
        • asp_comment_results
        • asp_blog_results
        • asp_terms_results
        • asp_peepso_group_results
        • asp_peepso_activities_results
        • asp_only_keyword_results
        • asp_only_non_keyword_results
        • asp_result_groups
      • CSS & JS
        • asp_load_js
        • asp_load_css
        • asp_load_css_js
      • Template & Output
        • asp_icl_t
      • Index Table Related
        • asp_index_on_save_stop
        • asp_indexing_keywords
        • asp_indexing_string_pre_process
        • asp_indexing_string_post_process
        • asp_post_content_before_tokenize_clear
        • asp_post_content_before_tokenize
        • asp_post_excerpt_before_tokenize
        • asp_post_title_before_tokenize
        • asp_file_contents_before_tokenize
        • asp_post_permalink_before_tokenize
        • asp_index_terms
        • asp_post_custom_field_before_tokenize
        • asp_index_cf_contents_before_tokenize
        • asp_index_before_shortcode_execution
        • asp_index_after_shortcode_execution
    • Templating
      • Filter layouts Templating
      • Result Templating
    • Constants
  • Frontend Filters
    • Taxonomy Filters
      • Restricting results to the same category as the current post object
      • How to automatically check/select filter values based on the archive page?
    • Frontend filters API
  • Tips & Miscellaneous
    • Divi
      • Divi Blogs Live Search and Filter
    • Jet Engine
      • Jet Engine Listing Grid Live Search and Filter
      • Searching Jet Engine Custom Meta Storage fields
    • Tutorials
      • PDF results thumbnails
      • Demo setup: Staff search and Filter
      • Demo Setup: WooCommerce Search
      • Demo setup: WooCommerce Shop Search and Filter
      • Demo Setup: Events Search – Events Manager
      • Demo Setup: Events Search – The Events Calendar
      • Compact ‘pop-out’ search bar placement on specific pages only
      • Index Table – Indexing ACF repeater field titles and contents
      • Change Suggested Phrases conditionally
      • How to add shortcode to the results content?
      • How to add variables to the “redirect to url” or the “show more url”?
      • Indexing Shortcodes within custom field contents
    • Post Types
      • Index Table - Indexing child post contents to parent
      • Limit results to specific post IDs only
      • Filter posts (or CPT) which user can’t access
      • Restricting results by user Groups using the Groups plugin by itthinx
      • Limiting results to specific posts by parent ID
      • Limit results to current page children
      • Excluding posts or CPT by parent ID(s)
      • Searching posts, pages (or any CPT) by specified keywords only, nothing else
      • Showing the post type name in result title or content
      • Searching within given categories/taxonomy terms only
      • Search only in the same category as the current post or page (single page)
      • Search only within the current category (or any taxonomy) archive
      • Filtering pages by page template
    • Taxonomy Terms
      • Displaying taxonomy name in taxonomy term results
      • Limiting taxonomy term results to specific term IDs only
    • WooCommerce
      • Displaying On Sale products only in WooCommerce
      • Ordering product by stock status
      • Making a product in-stock & out of stock filter
      • Add to cart button for Vertical and Horizontal results
      • Get formatted price in result title or in content
      • Showing products in-stock only
      • Showing in-stock and backorder products only
      • Excluding hidden catalog products
      • Showing featured products first
      • How to search products & product SKU?
      • How to search Products by variation SKUs?
      • Search product attributes
      • How to search users by city, state, zip code… ?
    • Compatibility
      • WPML Compatibility issues and fixes
    • Files & Media
      • Searching Image EXIF metadata
    • Other
      • Restrict results from the current author archive page
      • Presetting search options via a custom URL
      • Matomo analytics tracking integration
      • Replace search keywords (whole words)
      • Replace or remove characters from search phrase
      • Adding spaces in search phrase between alphabetics and numbers
      • How to change the results URL to something else?
      • Numbering the results
      • How to use the search without the live ajax feature, as a regular search?
      • Empty search input field on the search results page
      • Singular and Plural keywords index
  • Other
    • SearchQuery
    • REST API
    • Building a custom REST API
    • Javascript API
    • Javascript Hooks
      • asp_redirect_url
      • asp_search_data
      • asp_live_load_html
      • asp_search_html
      • asp_compact_width
    • Theme Functions
Powered by GitBook
On this page
  • Usage
  • Example uses
  1. Other

SearchQuery

SearchQuery class usage to fetch results with Ajax Search Pro

The WPDRMS\ASP\Query\SearchQuery() class is a wrapper to access Ajax Search Pro search features programmatically in your own code.

Usage

$asp_query = new WPDRMS\ASP\Query\SearchQuery();
foreach ( $asp_query->posts as $result ) {
	/**
	* $result (stdClass object) {
	*   -> Same properties as in WP_Post +
	*   'asp_data' (stdClass object) {	
	*      Properties always present:	
	*         'id' -> Post or other result object (taxonomy term, user etc..) ID,
	*         'title' -> Result title
	*         'content' -> Result content
	*         'image' -> Result image URL
	*         'post_type' -> Result post type (if available)
	*         'content_type' -> Content type (pagepost, user, term, attachment etc..)
	*         'author' -> Author display name (empty string where does not apply)
	*         'blogid' -> Blog ID (for multisites)
	*      Optional properties
	*         'post_mime_type' -> (for media results only) Mime type
	*         'taxonomy' -> (for term results only) Taxonomy name
	*         'user_login' -> (for user results only) User login name
	*         'user_nicename' -> (for user results only) User nicename
	*         'user_display_name' -> (for user results only) User display_name
	*   }
	* }
	**/	
	// do your thing
	var_dump($result);
}

The class constructor accepts two optional parameters, the arguments, and the search ID

$asp_query = new WPDRMS\ASP\Query\SearchQuery( array $args, int $search_id );
  • $search_id (int) - the relevant search instance ID. When set, the plugin will fetch the search instance default configuration and use them as the default query arguments. The $args argument can still override this default configuration if needed.

Example uses

Generic search by default configuration, without search instance

$args = array(
	's' => 'test'
);
$asp_query = new WPDRMS\ASP\Query\SearchQuery($args);
foreach ( $asp_query->posts as $result ) {
	// do your thing
}

Search based on configuration of search instance = 1

$args = array(
	's' => 'test'
);
$asp_query = new WPDRMS\ASP\Query\SearchQuery($args, 1);
foreach ( $asp_query->posts as $result ) {
	// do your thing
}

Generic search with more arguments

$args = array(
	"s" => $phrase,
	"_ajax_search" => false,
	'keyword_logic' => 'AND',
	'secondary_logic' => 'OR',
	"posts_per_page" => 20,
	'post_type' => $ptypes,
	'post_status' => array('publish', 'future', 'pending', 'private'),
	'post_fields' => array(
		'title', 'ids'
	)
);
$asp_query = new WPDRMS\ASP\Query\SearchQuery();
foreach ( $asp_query->posts as $result ) {
	// do your thing
}
PreviousSingular and Plural keywords indexNextREST API

Last updated 3 months ago

$args (array) - array of search arguments, for the possible arguments please check the

For the possible arguments please check the

asp_query_args documentation
asp_query_args documentation