WP-CLI Commands

Overview

Advanced Woo Search plugin supports several commands for WordPress command-line interface ( WP-CLI ). With such commands you can perform the actions like index plugin table or search via specific terms right from your command-line interface.

Before using these commands make sure that you install all necessary packages. More information about this you can find on WP-CLI project site.

Index

Here is a list of commands related to the plugin index table.

wp awssearch index --type=status

Check the status of the index table.

wp awssearch index --type=all

Index or reindex plugin table. Will index all your shop products.

wp awssearch index --type=update

Reindex plugin table. Use additional parameter --id={PRODUCT_ID} to reindex only specific products.

wp awssearch index --type=update --id=123

Reindex only specific products with ID 123.

wp awssearch index --type=delete

Delete the whole index table. Use additional parameter --id={PRODUCT_ID} to delete only specific product data from the index table.

wp awssearch index --type=delete --id=123

Remove all data related to the product with ID 123 from the index table.

Search

Perform search operations right inside the command line interface.

wp awssearch search {myterm}

Search for {myterm} term and return all search results as array.

Parameters

--num={num}

Number of product search results to return.

wp awssearch search {myterm} --num=10

--return={return}

What data to return. Set to ids to return only products/taxonomies IDs instead of full data.

wp awssearch search {myterm} --return=ids

--type={type}

What search results to return ( products, tax, users ). By default it will inherit values that were set via plugin settings page.

wp awssearch search {myterm} --type=products

wp awssearch search {myterm} --type=tax

--form_id={form_id} ( PRO version only )

Perform the search via a specific instance.

wp awssearch search {myterm} --form_id=11

--filter_id={filter_id} ( PRO version only )

Use specific filter options for searching.

wp awssearch search {myterm} --form_id=11 --filter_id=1

Cache

Clear plugin cache for search results.

wp awssearch cache_clear

Info

Display plugin specific information.

wp awssearch info