asp_query_args

Knowledge Base - Ajax Search Pro for WordPress
Buy Ajax Search Pro!Documentation Get Support
Search…
asp_query_args
The asp_query_args filter provides a possibility to add/remove/change query arguments right before they are passed to the ajax search pro main query.
This filter is executed after the search options were processed!
1
add_filter("asp_query_args", "asp_query_args_change", 10, 2);
2
​
3
function asp_query_args_change($args, $search_id) {
4
  // Do your stuff with the $args array
5
  // ....  
6
  // Then return
7
  return $args;
8
}
Copied!
Parameters
$args - the array of the arguments (structure detailed in chapter below)
$search_id - the current search ID
Example: Explicitly changing the post types and post fields to search
1
add_filter("asp_query_args", "asp_query_args_change", 10, 2);
2
​
3
function asp_query_args_change($args, $search_id) {
4
  // Changing post types to post and page
5
  $args['post_type'] = array('post', 'page');
6
  // Search only title and content
7
  $args['post_fields'] = array('title', 'content');
8
​
9
  return $args;
10
}
Copied!
Key list for the $args variable
For the complete $args source list please check: 
wp-content/plugins/ajax-search-pro/classes/search/class-asp-query.php
The $args array is the heart and soul of this filter. By changing it's key values you can directly affect the search outcome.
The default values of the key arguments depend on the search intance configuration and the passed arguments from the front-end before the search process.
Generic arguments
's' - Search phrase
The search phrase.
1
$args['s'] = "some phrase";
Copied!
'search_type' - Search content types
Determines the search content types. If you wish to return different content types as defined in the search instance option, then this needs to be properly stated within this option.
Type: array, Possible values:
cpt -> posts, pages, custom post types
taxonomies -> tags, categories and taxonomy terms based on taxonomy slug
users -> users
blogs -> multisite blog titles
buddypress -> buddypress groups or activities
comments -> comment results
attachments -> file attachments
1
// Default:
2
$args['search_type'] = array('cpt');
3
​
4
// Usage:
5
$args['search_type'] = array('cpt', 'taxonomies');
Copied!
'engine' - Search engine type
The search engine to use (regular or index). Change this to "index" only if the index table is configured!!
Type: string, Possible values: regular, index
1
// Default
2
$args['engine'] = 'regular';
3
​
4
// Changing to index
5
$args['engine'] = 'index';
Copied!
'keyword_logic' - Keyword logic
The keyword connection logic which is used for the entered search phrases.
Type: string, Possible values: 
OR (default) - matches if either of the phrases matches, even partially
AND - matches if both phrases match, even partially
OREX - matches if either of the phrases matches, only whole words
ANDEX - matches if both phrases match, only whole words
1
// Default
2
$args['keyword_logic'] = 'OR';
3
​
4
// Force change to AND
5
$args['keyword_logic'] = 'AND';
Copied!
Global results limit
The maximum number of results set. If set to 0, then the result type limits are used instead.
If explicitly set to higher than 0, then the results count is distributed evenly for each source.
1
// Default
2
$args['limit'] = 0;
3
​
4
// Set to any integer
5
$args['keyword_logic'] = 50;
Copied!
Results limit by results type
Only works if the 'limit' argument is set to 0. Defines limits for each source. The '_override' suffixed arguments are for the non-ajax search results.
1
// Custom post type limits
2
$args['posts_limit'] = 10;
3
$args['posts_limit_override'] = 50;
4
$args['taxonomies_limit']  = 10;
5
$args['taxonomies_limit_override'] = 20;
6
$args['users_limit'] = 10;
7
$args['users_limit_override'] = 20;
8
$args['blogs_limit'] = 10;
9
$args['blogs_limit_override'] = 20;
10
$args['buddypress_limit'] = 10;
11
$args['buddypress_limit_override'] = 20;
12
$args['comments_limit'] = 10;
13
$args['comments_limit_override'] = 20;
14
$args['attachments_limit'] = 10;
15
$args['attachments_limit_override'] = 20;
Copied!
Post & custom post type search related arguments
These arguments affect the post/cpt search.
'post_type' - Post type
Array of post types to search within.
Type: array, Possible values: post, page, ..any registered post type slug
1
// Default
2
$args['post_type'] = array('post', 'page');
3
​
4
// Search in product as well
5
$args['post_type'] = array('post', 'page', 'product');
Copied!
'post_status' - Post statuses
Array of post statuses
Type: array, Possible values: publish, draft, private, trash, ..any registered custom status
1
// Default
2
$args['post_status'] = array('publish');
3
​
4
// Search in drafts as well
5
$args['post_status'] = array('publish', 'draft');
Copied!
'post_fields' - Post fields to search in
Array of search fields to search in
Type: array, Possible values: 'title', 'content', 'excerpt', 'terms'
1
// Default
2
$args['post_status'] = array('title', 'content', 'excerpt', 'terms');
Copied!
'post_custom_fields' - Post custom fields to search
Array of custom field name
Type: array, Possible values: any custom field name
1
// Default
2
$args['post_custom_fields'] = array();
3
​
4
// Assigning custom field names
5
$args['post_custom_fields'] = array('custom_field1', 'custom_field2');
Copied!
'post_in' - Posts by IDs
Limit potential results pool to array of IDs. This only affects the potential result pool, all the other defined criteria must also match!
Type: array, Possible values: existing post IDs
1
// Default
2
$args['post_in'] = array();
3
​
4
// Include certain posts
5
$args['post_in'] = array(1, 2, 3, 4);
Copied!
'post_not_in' - Posts exclusion by IDs
Explicity exclude IDs from search results
Type: array, Possible values: existing post IDs
1
// Default
2
$args['post_not_in'] = array();
3
​
4
// Include certain posts
5
$args['post_not_in'] = array(5, 6, 7, 8);
Copied!
Primary and secondary ordering
Type: string, Possible values: 'relevance DESC', 'post_date DESC', 'post_date ASC', 'post_title DESC', 'post_title ASC'
1
// Default
2
$args['post_primary_order'] = "relevance DESC";
3
$args['post_secondary_order'] = "post_date DESC";
Copied!
'post_tax_filter' - Filter posts by taxonomy terms
Array of taxonomy term rules.
Type: array, Possible values: array of rules
1
// Default
2
$args['post_tax_filter'] = array();
3
​
4
// Exclude posts from categories 1,2,3,4 and include from 5,6,7,8
5
$args['post_tax_filter'] = array(
6
    array(
7
        'taxonomy'  => 'category',
8
        'include'   => array(1, 2, 3, 4), 
9
        'exclude'   => array(5, 6, 7, 8),
10
        'allow_empty' => true // Allow results, that does not have connection with this taxonomy
11
    )
12
);
13
​
14
// Exclude Posts from certain categories, include from certain tags
15
$args['post_tax_filter'] = array(
16
    array(
17
        'taxonomy'  => 'category',
18
        'include'   => array(), 
19
        'exclude'   => array(5, 6, 7, 8)
20
    ),
21
    array(
22
        'taxonomy'  => 'post_tag',
23
        'include'   => array(10, 11, 23, 44), 
24
        'exclude'   => array()
25
    )
26
);
Copied!
'post_meta_filter' - Filter posts by post meta (custom fields)
Array of custom field rules.
Type: array, Possible values: array of rules
1
// Default
2
$args['post_meta_filter'] = array();
3
​
4
// Usage with operators
5
$args['post_meta_filter'] = array(
6
    array(
7
        'key'     => 'age',         // meta key
8
        'value'   => array( 3, 4 ), // int|float|string|array|timestamp|datetime
9
         // @param string|array compare
10
         // Numeric Operators
11
         //      '<' -> less than
12
         //      '>' -> more than
13
         //      '<>' -> not equals
14
         //      '=' -> equals
15
         //      'BETWEEN' -> between two values
16
         // String Operators
17
         //      'LIKE'
18
         //      'NOT LIKE'
19
         //      'IN'
20
        'operator' => 'BETWEEN',
21
        'allow_missing' => false   // allow match if this custom field is unset
22
    )
23
    // .. additional rules ..
24
);
Copied!
'post_date_filter' - Filter posts by dates
Array of date rules.
Type: array, Possible values: array of rules
1
// Default
2
$args['post_date_filter'] = array();
3
​
4
// By year, month, day given separately
5
$args['post_date_filter'] = array(
6
    array(
7
        'year'  => 2015,            // year, month, day ...
8
        'month' => 6,
9
        'day'   => 1,
10
        'operator' => 'include',    // include|exclude
11
        'interval' => 'before'      // before|after
12
    )
13
);
14
​
15
// By given y-m-d format
16
$args['post_date_filter'] = array(
17
    array(
18
        'date'  => "2015-06-01",     // .. or date parameter in y-m-d format
19
        'operator' => 'include',    // include|exclude
20
        'interval' => 'before'      // before|after
21
    )
22
);
Copied!
'post_user_filter' - Filter by author (user)
Array of user rules.
Type: array, Possible values: array of rules
1
// Default
2
$args['post_user_filter'] = array();
3
​
4
// Include/Exclude by user IDs
5
$args['post_user_filter'] = array(
6
    'include' => (1, 2, 3, 4),  // include by User IDs
7
    'exclude' => (5, 6, 7, 8)   // exclude by User IDs
8
);
Copied!
Attachment search related arguments
Before adjusting the settings, enable attachment search explicitly:
1
if ( !in_array('attachments', $args['search_type']) )
2
    $args['search_type'][] = 'attachments';
Copied!
Default attachment search arguments:
1
// Defaults
2
$args['attachments_search_title']  = true;
3
$args['attachments_search_content'] = true;
4
$args['attachments_search_caption'] = true;
5
$args['attachments_search_terms'] = false;
6
// Use attachment as image if it is an image type
7
$args['attachment_use_image'] = true;
8
$args['attachment_mime_types'] = array(
9
  'image/jpeg', 
10
  'image/gif',
11
  'image/png',
12
  'image/tiff',
13
  'image/x-icon'
14
);
15
// Exclude attachments by ID
16
$args['attachment_exclude']    = array();
Copied!
For the possible mime types, see the mime types table on the attachment search documentation page.
BuddyPress search related arguments
Before adjusting the settings, enable buddypress search explicitly:
1
if ( !in_array('buddypress', $args['search_type']) )
2
    $args['search_type'][] = 'buddypress';
Copied!
Default arguments:
1
// BuddyPress default arguments
2
// Search in groups
3
$args['bp_groups_search']          = false,
4
// Search in public groups
5
$args['bp_groups_search_public']   = true;
6
// Search in private groups
7
$args['bp_groups_search_private']  = true;
8
// Search in hidden groups 
9
$args['bp_groups_search_hidden']   = true;
10
// Search in user activities
11
$args['bp_activities_search']      = true;
Copied!
Taxonomy Term (category) search arguments
Before adjusting the settings, enable taxonomies search explicitly:
1
if ( !in_array('taxonomies', $args['search_type']) )
2
    $args['search_type'][] = 'taxonomies';
Copied!
Default arguments:
1
$args['taxonomy_include'] = array("category", "post_tag"); // taxonomies to search for terms
2
$args['taxonomy_terms_exclude'] = array();     // terms to exclude by ID
3
$args['taxonomy_terms_search_description'] = true;
4
$args['_taxonomy_posts_affected'] => true;     // Display the number of posts affected
Copied!
User search related arguments
Before adjusting the settings, enable users search explicitly:
1
if ( !in_array('users', $args['search_type']) )
2
    $args['search_type'][] = 'users';
Copied!
Default arguments:
1
$args['user_login_search'] = true;
2
$args['user_display_name_search'] = true;
3
$args['user_first_name_search'] = true;
4
$args['user_last_name_search'] = true;
5
$args['user_bio_search'] = true;
6
​
7
// Array of meta fields
8
$args['user_search_meta_fields'] = array();
9
​
10
// Array of buddypress fields
11
$args['user_search_bp_fields'] = array();
12
​
13
// Array of roles to exclude
14
$args['user_search_exclude_roles'] = array();
Copied!