API Documentation
\

\

Classes

ajaxLiveSearch Main ajaxLiveSearch class
alsSearch Main Search class
PorterStemmer PHP5 Implementation of the Porter Stemmer algorithm. Certain elements were borrowed from the (broken) implementation by Jon Abernathy.
WP_Elements_Als Main WP_Elements Class.

Constants

ALS_LOADING_AJAX_RESULTS

ALS_LOADING_AJAX_RESULTS

Functions

als_add_page()

als_add_page()

als_admin_init()

als_admin_init()

als_admin_render()

als_admin_render()

als_ajax_init()

als_ajax_init() : void

Prints the frontend HTML needed to run Ajax Live Search

als_csv_get()

als_csv_get()

Handles ajax requests for csv files

als_front_scripts()

als_front_scripts() : null

Fires during the wp_enqueue_scripts action hook

Returns

null

als_get_option()

als_get_option(  $option = false) : mixed

Gets a user defined option

Parameters

$option

Returns

mixed —

bool when no value is found; the value otherwise

als_get_results()

als_get_results()

Handles the ajax requests for search results

als_get_search_query()

als_get_search_query(  $s)

Filters the search query

Parameters

$s

als_get_suggestions()

als_get_suggestions() : null

Fires when the user requests search results via ajax search

Returns

null

als_is_array()

als_is_array(  $array) : boolean

Validates an array

Parameters

$array

the array to validate

Returns

boolean —

true on validate or false on invalid value

als_is_string()

als_is_string(  $string) : boolean

Validates a string

Parameters

$string

the string to validate

Returns

boolean —

true on validate or false on invalid value

als_lite()

als_lite()

als_post_types()

als_post_types() : array

Returns an array of searchable post types.

Returns

array —

an array of selected post types

als_query_modifier()

als_query_modifier(  $modifier,   $q) : boolean

Get's a given search modifier from a search term

Parameters

$modifier

the modifier eg intittle:
$q

the query

Returns

boolean —

true on validate or false on invalid value

als_results_vs_no_results()

als_results_vs_no_results() : array

Returns an array containing the number of searches containing results and searches that don't have results.

For example; If it returns array(10, 20), that means that 10 searches lacked results while 20 searches on the website had results.

Returns

array —
  • An array containg the number of searches without results and those with results.

als_wp_head()

als_wp_head() : void

Fires during the wp_head hook.

Prints the required css and meta elements.

picosearch_add_page()

picosearch_add_page()

picosearch_admin_init()

picosearch_admin_init()

picosearch_admin_render()

picosearch_admin_render()

picosearch_render_wrapper_end()

picosearch_render_wrapper_end()

picosearch_render_wrapper_open()

picosearch_render_wrapper_open(  $element_id,   $args)

Parameters

$element_id
$args

picosearch_reports_render()

picosearch_reports_render()

picosearch_welcome_render()

picosearch_welcome_render()

WE_als()

WE_als(  $id = false) : \WP-Elements

Main instance of WP-Elements.

Returns the main instance of PC to prevent the need to use globals.

Parameters

$id

Returns

\WP-Elements