diff --git a/404.html b/404.html
old mode 100644
new mode 100755
index d05ebd6..a9f84a0
--- a/404.html
+++ b/404.html
@@ -14,7 +14,7 @@
PHP 7.4 required or greater MySQL 5.6 or greater is recommended "},{"location":"#automatic-installation","title":"Automatic Installation","text":" Go to WordPress Plugins > Add New Search for \"Search with Typesense\" Click Install and then activate Plugin "},{"location":"#manual-installation","title":"Manual Installation","text":"If for some reason automatic installation is not possible, go to https://wordpress.org/plugins/search-with-typesense/ and you will see the download button. Clicking download button will provide you with a zip file of the plugin then.
Go to WordPress Plugins > Add New and click upload plugin. Click upload plugin and then add the zip file The plugin will then be installed, then activate the plugin. "},{"location":"advanced-custom-post-types/","title":"Adding Custom Post Type","text":""},{"location":"advanced-custom-post-types/#introduction","title":"Introduction","text":"By default, the plugin supports posts and pages for indexing. Adding additional / custom post types can be achieve via filter hooks. There are three things you should be aware of.
Adding the custom post type to available post types for indexing Adding schema for your custom post type Formatting data before documents are added For this guide - we have assumed that the custom post type is book, please note that the slug of custom post type is quite important.
/**\n * Register a custom post type called \"book\".\n *\n * @see get_post_type_labels() for label keys.\n */\nfunction wp_docs_codex_book_init() {\n $labels = array(\n 'name' => _x( 'Books', 'Post type general name', 'textdomain' ),\n 'singular_name' => _x( 'Book', 'Post type singular name', 'textdomain' ),\n 'menu_name' => _x( 'Books', 'Admin Menu text', 'textdomain' ),\n 'name_admin_bar' => _x( 'Book', 'Add New on Toolbar', 'textdomain' ),\n 'add_new' => __( 'Add New', 'textdomain' ),\n 'add_new_item' => __( 'Add New Book', 'textdomain' ),\n 'new_item' => __( 'New Book', 'textdomain' ),\n 'edit_item' => __( 'Edit Book', 'textdomain' ),\n 'view_item' => __( 'View Book', 'textdomain' ),\n 'all_items' => __( 'All Books', 'textdomain' ),\n 'search_items' => __( 'Search Books', 'textdomain' ),\n 'parent_item_colon' => __( 'Parent Books:', 'textdomain' ),\n 'not_found' => __( 'No books found.', 'textdomain' ),\n 'not_found_in_trash' => __( 'No books found in Trash.', 'textdomain' ),\n 'featured_image' => _x( 'Book Cover Image', 'Overrides the \u201cFeatured Image\u201d phrase for this post type. Added in 4.3', 'textdomain' ),\n 'set_featured_image' => _x( 'Set cover image', 'Overrides the \u201cSet featured image\u201d phrase for this post type. Added in 4.3', 'textdomain' ),\n 'remove_featured_image' => _x( 'Remove cover image', 'Overrides the \u201cRemove featured image\u201d phrase for this post type. Added in 4.3', 'textdomain' ),\n 'use_featured_image' => _x( 'Use as cover image', 'Overrides the \u201cUse as featured image\u201d phrase for this post type. Added in 4.3', 'textdomain' ),\n 'archives' => _x( 'Book archives', 'The post type archive label used in nav menus. Default \u201cPost Archives\u201d. Added in 4.4', 'textdomain' ),\n 'insert_into_item' => _x( 'Insert into book', 'Overrides the \u201cInsert into post\u201d/\u201dInsert into page\u201d phrase (used when inserting media into a post). Added in 4.4', 'textdomain' ),\n 'uploaded_to_this_item' => _x( 'Uploaded to this book', 'Overrides the \u201cUploaded to this post\u201d/\u201dUploaded to this page\u201d phrase (used when viewing media attached to a post). Added in 4.4', 'textdomain' ),\n 'filter_items_list' => _x( 'Filter books list', 'Screen reader text for the filter links heading on the post type listing screen. Default \u201cFilter posts list\u201d/\u201dFilter pages list\u201d. Added in 4.4', 'textdomain' ),\n 'items_list_navigation' => _x( 'Books list navigation', 'Screen reader text for the pagination heading on the post type listing screen. Default \u201cPosts list navigation\u201d/\u201dPages list navigation\u201d. Added in 4.4', 'textdomain' ),\n 'items_list' => _x( 'Books list', 'Screen reader text for the items list heading on the post type listing screen. Default \u201cPosts list\u201d/\u201dPages list\u201d. Added in 4.4', 'textdomain' ),\n );\n\n $args = array(\n 'labels' => $labels,\n 'public' => true,\n 'publicly_queryable' => true,\n 'show_ui' => true,\n 'show_in_menu' => true,\n 'query_var' => true,\n 'rewrite' => array( 'slug' => 'book' ),\n 'capability_type' => 'post',\n 'has_archive' => true,\n 'hierarchical' => false,\n 'menu_position' => null,\n 'supports' => array( 'title', 'editor', 'author', 'thumbnail', 'excerpt', 'comments' ),\n );\n\n register_post_type( 'book', $args );\n}\n\nadd_action( 'init', 'wp_docs_codex_book_init' );\n/**\n * Create two taxonomies, genres and writers for the post type \"book\".\n *\n * @see register_post_type() for registering custom post types.\n */\nfunction wp_docs_create_book_taxonomies() {\n // Add new taxonomy, make it hierarchical (like categories)\n $labels = array(\n 'name' => _x( 'Genres', 'taxonomy general name', 'textdomain' ),\n 'singular_name' => _x( 'Genre', 'taxonomy singular name', 'textdomain' ),\n 'search_items' => __( 'Search Genres', 'textdomain' ),\n 'all_items' => __( 'All Genres', 'textdomain' ),\n 'parent_item' => __( 'Parent Genre', 'textdomain' ),\n 'parent_item_colon' => __( 'Parent Genre:', 'textdomain' ),\n 'edit_item' => __( 'Edit Genre', 'textdomain' ),\n 'update_item' => __( 'Update Genre', 'textdomain' ),\n 'add_new_item' => __( 'Add New Genre', 'textdomain' ),\n 'new_item_name' => __( 'New Genre Name', 'textdomain' ),\n 'menu_name' => __( 'Genre', 'textdomain' ),\n );\n\n $args = array(\n 'hierarchical' => true,\n 'labels' => $labels,\n 'show_ui' => true,\n 'show_admin_column' => true,\n 'query_var' => true,\n 'rewrite' => array( 'slug' => 'genre' ),\n );\n\n register_taxonomy( 'genre', array( 'book' ), $args );\n\n unset( $args );\n unset( $labels );\n\n // Add new taxonomy, NOT hierarchical (like tags)\n $labels = array(\n 'name' => _x( 'Writers', 'taxonomy general name', 'textdomain' ),\n 'singular_name' => _x( 'Writer', 'taxonomy singular name', 'textdomain' ),\n 'search_items' => __( 'Search Writers', 'textdomain' ),\n 'popular_items' => __( 'Popular Writers', 'textdomain' ),\n 'all_items' => __( 'All Writers', 'textdomain' ),\n 'parent_item' => null,\n 'parent_item_colon' => null,\n 'edit_item' => __( 'Edit Writer', 'textdomain' ),\n 'update_item' => __( 'Update Writer', 'textdomain' ),\n 'add_new_item' => __( 'Add New Writer', 'textdomain' ),\n 'new_item_name' => __( 'New Writer Name', 'textdomain' ),\n 'separate_items_with_commas' => __( 'Separate writers with commas', 'textdomain' ),\n 'add_or_remove_items' => __( 'Add or remove writers', 'textdomain' ),\n 'choose_from_most_used' => __( 'Choose from the most used writers', 'textdomain' ),\n 'not_found' => __( 'No writers found.', 'textdomain' ),\n 'menu_name' => __( 'Writers', 'textdomain' ),\n );\n\n $args = array(\n 'hierarchical' => false,\n 'labels' => $labels,\n 'show_ui' => true,\n 'show_admin_column' => true,\n 'update_count_callback' => '_update_post_term_count',\n 'query_var' => true,\n 'rewrite' => array( 'slug' => 'writer' ),\n );\n\n register_taxonomy( 'writer', 'book', $args );\n}\n\n// hook into the init action and call create_book_taxonomies when it fires\nadd_action( 'init', 'wp_docs_create_book_taxonomies', 0 );\nTo add custom post types, cm_typesense_available_index_types needs to be used like below:
function cm_typesense_add_available_post_types( $available_post_types ) {\n $available_post_types['book'] = [ 'label' => 'Book', 'value' => 'book' ];\n\n return $available_post_types;\n}\nadd_filter( 'cm_typesense_available_index_types', 'cm_typesense_add_available_post_types');\n\nNote: This hook is available since version 1.3.0. Before version 1.3.0, cm_typesense_available_post_types needs to be used for the purspose.
This will add your custom post type to the available post types dropdown in the backend. Which will allow you to enable the post type and index it.
IMPORTANT NOTE: Please note the index and value MUST be the post_slug
Result:
"},{"location":"advanced-custom-post-types/#adding-schema","title":"Adding Schema","text":"Your schema for the custom post type would most likely need to be different for your custom post type. For example you may want to send custom taxonomies as facets for your post type. To do so you will need to modify / add your schema - BEFORE - any indexing is done
IMPORTANT NOTE: SCHEMA NEEDS TO BE DEFINED BEFORE COLLECTION IS CREATED.
//only necessary if the default post schema is not necessary\nfunction cm_typesense_add_book_schema( $schema, $name ) {\n if ( $name == 'book' ) {\n $schema = [\n 'name' => 'book',\n 'fields' => [\n [ 'name' => 'post_content', 'type' => 'string' ],\n [ 'name' => 'post_title', 'type' => 'string' ],\n [ 'name' => 'post_type', 'type' => 'string' ],\n [ 'name' => 'post_author', 'type' => 'string' ],\n [ 'name' => 'comment_count', 'type' => 'int64' ],\n [ 'name' => 'is_sticky', 'type' => 'int32' ],\n [ 'name' => 'post_excerpt', 'type' => 'string' ],\n [ 'name' => 'post_date', 'type' => 'string' ],\n [ 'name' => 'post_id', 'type' => 'string' ],\n [ 'name' => 'post_modified', 'type' => 'string' ],\n [ 'name' => 'id', 'type' => 'string' ],\n [ 'name' => 'permalink', 'type' => 'string' ],\n [ 'name' => 'post_thumbnail', 'type' => 'string' ],\n [ 'name' => 'genre', 'type' => 'string[]', 'facet' => true ]\n ],\n 'default_sorting_field' => 'comment_count'\n ];\n }\n\n\n return $schema;\n}\n\nadd_filter( 'cm_typesense_schema', 'cm_typesense_add_book_schema', 10, 2 );\nIn the example above - you can see genre is being sent as a facet. \"genre\" is the custom taxonomy attached to the book post type.
"},{"location":"advanced-custom-post-types/#formatting-data","title":"Formatting Data","text":"//you can modify the code as needed \n//if your schema is simillar to the default post type then you should only change what fields you need to add\n//example here we are only adding genre\nfunction cm_typesense_format_book_data ( $formatted_data, $raw_data, $object_id, $schema_name ) {\n if ( $schema_name == 'book' ) {\n $terms = get_the_terms( $object_id, 'genre' );\n $genres = [];\n foreach ( $terms as $term ) {\n $genres[] = $term->name;\n }\n $formatted_data['genre'] = $genres;\n }\n\n return $formatted_data;\n}\nadd_filter( 'cm_typesense_data_before_entry', 'cm_typesense_format_book_data', 10, 4 );\nAdding custom or additional taxonomy as a collection. From version 1.3.1 - the plugin adds the default post category as an indexable taxonomy option. To add additional/custom taxonomy - the following steps are required
Add as Available Index Type Add Schema for Custom Taxonomy Format Document Before Entry (optional) This example assumes that you have a custom post type called book, and a custom taxonomy called genre
/**\n * Create genres for the post type \"book\".\n *\n * @see register_post_type() for registering custom post types.\n */\nfunction wp_docs_create_book_taxonomies() {\n // Add new taxonomy, make it hierarchical (like categories)\n $labels = array(\n 'name' => _x( 'Genres', 'taxonomy general name', 'textdomain' ),\n 'singular_name' => _x( 'Genre', 'taxonomy singular name', 'textdomain' ),\n 'search_items' => __( 'Search Genres', 'textdomain' ),\n 'all_items' => __( 'All Genres', 'textdomain' ),\n 'parent_item' => __( 'Parent Genre', 'textdomain' ),\n 'parent_item_colon' => __( 'Parent Genre:', 'textdomain' ),\n 'edit_item' => __( 'Edit Genre', 'textdomain' ),\n 'update_item' => __( 'Update Genre', 'textdomain' ),\n 'add_new_item' => __( 'Add New Genre', 'textdomain' ),\n 'new_item_name' => __( 'New Genre Name', 'textdomain' ),\n 'menu_name' => __( 'Genre', 'textdomain' ),\n );\n\n $args = array(\n 'hierarchical' => true,\n 'labels' => $labels,\n 'show_ui' => true,\n 'show_admin_column' => true,\n 'query_var' => true,\n 'rewrite' => array( 'slug' => 'genre' ),\n );\n\n register_taxonomy( 'genre', array( 'book' ), $args );\n}\n\n// hook into the init action and call create_book_taxonomies when it fires\nadd_action( 'init', 'wp_docs_create_book_taxonomies', 0 );\nThe following code will add the genre option to be selected and configured via Typesense > Typesense admin area. For a taxonomy it is implicitly required to define \"type => taxonomy\".
/** Add the genre option to available index list **/\n function cm_typesense_add_taxonomy( $available_post_types ) {\n $available_post_types['category'] = [ 'label' => 'Post Categories', 'value' => 'category', 'type' => 'taxonomy' ];\n\n return $available_post_types;\n }\n add_filter( 'cm_typesense_available_index_types', 'cm_typesense_add_taxonomy' );\n\nThe following code updates taxonomy - any time changes are made to taxonomy
function cm_typesense_add_taxonomy_for_update( $taxonomies ) {\n $taxonomies[] = 'genre';\n\n return $taxonomies;\n }\n\n add_filter( 'cm_typesense_enabled_taxonomy_for_post_type', 'cm_typesense_add_taxonomy_for_update' );\n*** Make sure the value for genre is the same as slug of the taxonomy. ***
"},{"location":"advanced-custom-taxonomy/#add-schema-for-custom-taxonomy","title":"Add Schema for Custom Taxonomy","text":"You can define - your taxonomy schema as any way you want. But to be compatible with the default autocomplete and instant search templates - please use the following base schema.
function cm_typesense_add_post_category_schema( $schema, $name ) {\n if ( $name == 'genre' ) {\n $schema = [\n 'name' => 'genre',\n 'fields' => [\n [ 'name' => 'term_id', 'type' => 'string' ],\n [ 'name' => 'id', 'type' => 'string' ],\n [ 'name' => 'taxonomy', 'type' => 'string' ],\n [ 'name' => 'post_title', 'type' => 'string' ],\n [ 'name' => 'post_content', 'type' => 'string' ],\n [ 'name' => 'slug', 'type' => 'string' ],\n [ 'name' => 'posts_count', 'type' => 'int64' ],\n [ 'name' => 'permalink', 'type' => 'string' ],\n ],\n 'default_sorting_field' => 'posts_count'\n ];\n }\n\n\n return $schema;\n }\n\nadd_filter( 'cm_typesense_schema', 'cm_typesense_add_post_category_schema', 10, 2 );\nThis step is only required if you are adding additional fields or have modified the schema. For example if schema has a thumbnail that you would like to show. Suppose I have added a post thumbnail field via ACF which return image URL. Then the schema would be
function cm_typesense_add_post_category_schema( $schema, $name ) {\n if ( $name == 'genre' ) {\n $schema = [\n 'name' => 'genre',\n 'fields' => [\n [ 'name' => 'term_id', 'type' => 'string' ],\n [ 'name' => 'id', 'type' => 'string' ],\n [ 'name' => 'taxonomy', 'type' => 'string' ],\n [ 'name' => 'post_title', 'type' => 'string' ],\n [ 'name' => 'post_content', 'type' => 'string' ],\n [ 'name' => 'slug', 'type' => 'string' ],\n [ 'name' => 'posts_count', 'type' => 'int64' ],\n [ 'name' => 'permalink', 'type' => 'string' ],\n ['name'=>'post_thumbnail','type'=>'string']\n ],\n 'default_sorting_field' => 'posts_count'\n ];\n }\n\n\n return $schema;\n }\n\nadd_filter( 'cm_typesense_schema', 'cm_typesense_add_post_category_schema', 10, 2 );\nThen we can add the data the following way
function cm_typesense_format_taxonomy_data_before_entry( $formatted_data, $raw_data, $object_id, $schema_name ) {\n if ( $schema_name == 'genre' ) {\n //only need to add the additional data\n $formatted_data['post_thumbnail'] = get_field( 'image', $raw_data ) ?? CODEMANAS_TYPESENSE_ROOT_URI_PATH . '/assets/placeholder.jpg';\n }\n\n return $formatted_data;\n }\n\n add_filter( 'cm_typesense_data_before_entry', 'cm_typesense_format_taxonomy_data_before_entry', 10, 4 );\nBy default, all facets for filtering are shown as refinementList. As of version 1.2.4 developers have the version to add between menu, rangeSlider or rangeInput.
Note: For rangeSlider and rangeInput the facet must be int64.
To do this you can use filer cm_typesense_filter_type. The following code is written in child themes functions.php file.
function cm_change_facet_widget_type( $filterType, $filterName ) {\n if ( $filterName == 'category' ) {\n $filterType = 'menu';\n } else if ( $filterName == 'comment_count' ) {\n /*For range slider the schema for field must be int64*/\n $filterType = 'rangeSlider';\n }\n\n return $filterType;\n}\n\nadd_filter( 'cm_typesense_filter_type', 'cm_change_facet_widget_type', 10, 2 );\nSuppose you added a new field for instance price in your schema and indexed it to TypeSense server. Now how to show the price in the result template?
To show the price in result tempalte, follow the steps below:
"},{"location":"customizing-default-hit-template/#1-register-a-custom-template-for-your-index-type","title":"1. Register a custom template for your index type","text":"First you have to register the custom template for your index type. The important part here is the id of the template. If you look at the code below, notice the id of the script is tmpl-cmswt-Result-itemTemplate--book. The last part of the id must be value of the index type you are registering with the hook cm_typesense_available_post_types.
<?php\nfunction cm_202208_add_book_hit_template() { ?>\n <script type=\"text/html\" id=\"tmpl-cmswt-Result-itemTemplate--book\">\n <div class=\"hit-header\">\n <# if(data.post_thumbnail !== undefined) { #>\n <a href=\"{{{data._highlightResult.permalink.value}}}\" class=\"hit-header--link\" rel=\"nofollow noopener\">\n <img src=\"{{{data.post_thumbnail}}}\"/>\n </a>\n <# } #>\n </div>\n <div class=\"hit-content\">\n <a href=\"{{{data._highlightResult.permalink.value}}}\" rel=\"nofollow noopener\"><h5 class=\"title\">{{{data.formatted.post_title}}}</h5></a>\n <# if( data.post_type === 'book' ) { #>\n <div class=\"hit-meta\">\n <span class=\"posted-on\">\n <time datetime=\"\">{{data.formatted.postedDate}}</time>\n </span>\n <# if ( Object.keys(data.formatted.cats).length > 0 ) { #>\n <div class=\"hit-cats\">\n <# for ( let key in data.formatted.cats ) { #>\n <div class=\"hit-cat\"><a href=\"{{{data.formatted.cats[key]}}}\">{{{key}}}</a>,</div>\n <# } #>\n </div>\n <# } #>\n <# } #>\n <div class=\"hit-description\">{{{data.formatted.post_content}}}</div>\n <div class=\"hit-link\">\n <a href=\"{{data.permalink}}\"><?php _e( 'Read More...', 'search-with-typesense' ); ?></a>\n </div>\n </div>\n </div>\n </script>\n<?php\n}\nadd_action( 'wp_footer', 'cm_202208_add_book_hit_template' );\nNote: The template above is the default template.
"},{"location":"customizing-default-hit-template/#2-showing-the-custom-field","title":"2. Showing the custom field","text":"In our case we want to show our custom field price, for that we change the above code by adding this line: <span class=\"price\">Price: ${{{data.price}}}</span>
<?php\nfunction your_prefix_custom_hits() {\n ?>\n <script type=\"text/html\" id=\"tmpl-cmswt-Result-itemTemplate--default\">\n <div class=\"hit-header\">\n <# if(data.post_thumbnail !== undefined) { #>\n <a href=\"{{{data._highlightResult.permalink.value}}}\" class=\"hit-header--link\" rel=\"nofollow noopener\">\n <img src=\"{{{data.post_thumbnail}}}\"/>\n </a>\n <# } #>\n </div>\n <div class=\"hit-content\">\n <# if(data._highlightResult.permalink !== undefined ) { #>\n <a href=\"{{{data._highlightResult.permalink.value}}}\" rel=\"nofollow noopener\"><h5 class=\"title\">{{{data.formatted.post_title}}}</h5></a>\n <# } #>\n <# if( data.post_type === 'book' ) { #>\n <div class=\"hit-meta\">\n <span class=\"posted-on\">\n <time datetime=\"\">{{data.formatted.postedDate}}</time>\n </span>\n <span class=\"price\">Price: ${{{data.price}}}</span>\n <# if ( Object.keys(data.formatted.cats).length > 0 ) { #>\n <div class=\"hit-cats\">\n <# for ( let key in data.formatted.cats ) { #>\n <div class=\"hit-cat\"><a href=\"{{{data.formatted.cats[key]}}}\">{{{key}}}</a>,</div>\n <# } #>\n </div>\n <# } #>\n <# } #>\n <div class=\"hit-description\">{{{data.formatted.post_content}}}</div>\n <div class=\"hit-link\">\n <a href=\"{{data.permalink}}\"><?php _e( 'Read More...', 'search-with-typesense' ); ?></a>\n </div>\n </div>\n </div>\n\n </script>\n<?php\n}\nadd_action( 'wp_footer', 'your_prefix_custom_hits' );\nTo debug or see what values are avialable to use, you can add {{console.log(data)}} inside the template and see the available datas.
In our custom example, this will log something like this:
"},{"location":"customizing-instant-search-widgets/","title":"Customizing Instant Search Widgets","text":"Since version 1.1.4 of the plugin two new filters have been added to customize Facets and the sort by widgets
Facets : cm_typesense_search_facet_settings Sort BY : cm_typesense_search_sortby_items "},{"location":"customizing-instant-search-widgets/#facet-customization","title":"Facet Customization","text":"To customize facets you can use the settings than can be passed to the refinementList, see available values here
A short example would be making Facet searchable and limit
function cm_typesense_facet_modifications( $facet_settings, $facet ) {\n if ( $facet == 'category' ) {\n $facet_settings = [\n 'searchable' => true,\n 'limit' => 1\n ];\n }\n\n return $facet_settings;\n}\n\nadd_filter( 'cm_typesense_search_facet_settings', 'cm_typesense_facet_modifications', 10, 2 );\nHere I'm checking that the facet is \"category\" and if it is I am modifying it to make the filter searchable and limit it to 1 result at time.
End Result
"},{"location":"customizing-instant-search-widgets/#sort-by-customization","title":"Sort By Customization","text":"You can only add items to sort by, to allow sorting by various fields. A word of caution this is dependent on your schema so please make sure you are only adding sortable fields here. You should see what are sortable fields in Typesense documentation here
Example to add sort by comment count the following code will work.
function cm_typesense_sortby_items( $items, $post_type ) {\n if ( $post_type == 'post' ) {\n $items[] = [ 'label' => 'Highest Comment Count', 'value' => $post_type . '/sort/comment_count:desc' ];\n }\n\n return $items;\n}\n\nadd_filter( 'cm_typesense_search_sortby_items', 'cm_typesense_sortby_items', 10, 2 );\n End Result
"},{"location":"debug/","title":"Debugging","text":"There are two types of logs: - Error Log - Debug Log
By default, Error Logs are enabled - you can disable them if you want. To do so go to WordPress Dashboard > Typesense > Settings
Dates for logs are all in UTC time for uniformity
"},{"location":"debug/#error-logs","title":"Error Logs:","text":"Error logs are logged if there is an error when a request is made to the Typesense node Some of the examples
Connection to Node cannot be established There was an error when inserting the document to the collection Error creating collection etc. "},{"location":"debug/#debug-log","title":"Debug Log:","text":"Debug log - logs every successful request made to Typesense. You can see the details of what is being sent to the node Another use for debug log would be when bulk indexing documents - if for some reason an error log is not generated and documents aren't being added to collection. You should turn on debug log - and view the log files - this is helpful to see when 1. For some reason a single post is not indexed - while bulk indexing 2. Bulk indexing does not index all posts / post_types.
"},{"location":"debug/#site-info","title":"Site Info:","text":"Site Info - Get info about your WordPress site with the schema info and your Typesense cloud server info
"},{"location":"debug/#curl-error-6-could-not-resolve-host","title":"cURL error 6: Could not resolve host","text":"This means your node could not be resolved.
To resolve this, verify the following:
Check if your credentials are right from the Typesense cloud keys and node. Your instance in Typesense cloud could have expired. Contact Typesense support for that. "},{"location":"getting-started/","title":"Getting Started","text":""},{"location":"getting-started/#generate-api-keys","title":"Generate API Keys","text":"Before you do anything else, you must first add the API keys and configure the node.
If you are hosting Typesense locally / on your own server. Then please see the steps here to generate API Keys https://typesense.org/docs/0.22.1/api/api-keys.html
Otherwise, if you have gone with Typesense cloud option - then once the cluster is set up. There will be an option to generate your API keys.
Above Shows overview of API Keys
Clicking \"Generate API Keys\" - will generate and download API Keys to be used. Keep this file safe and secure for future use.
The Text file will have the following information
Protocol: [https] Port: [443] Admin API Key Search Only API Key Node "},{"location":"getting-started/#configuring-plugin","title":"Configuring Plugin","text":""},{"location":"getting-started/#saving-settings","title":"Saving Settings","text":"After retrieving the required info go to WordPress > Admin Area > Typesense > Settings You will be guided to a page like so.
Here - enter the details provided in the text file and click save. Your WordPress install will now be able to connect to your typensese instance.
"},{"location":"getting-started/#setup-autocomplete-and-indexing","title":"Setup Autocomplete and Indexing","text":"The next step is to enable and start indexing your posts.
Going to Admin Area > Typesense
Here you can
Enable which post types should be indexed Bulk index the selected post types Replace WordPress Search to show autocomplete or instant search popup "},{"location":"getting-started/#enable-post-types","title":"Enable Post Types","text":"This option allows you to select which post types to index. By default the plugin allows you to index posts and pages.
"},{"location":"getting-started/#bulk-index","title":"Bulk Index","text":"Bulk Index option allows you to index all posts(post types) at once. Indexing means they will add the document into Typesense instant to be easily retrieved.
"},{"location":"getting-started/#replace-wordpress-search","title":"Replace WordPress Search","text":"When this option is enabled it will replace all search forms that use default WordPress search with either Instant Search popup or autocomplete. Developer Note: It will replace all calls for get_search_form() and the default WordPress search widget or \"core/search\" block used
"},{"location":"getting-started/#instant-search-popup","title":"Instant Search Popup","text":"Instant Search - replaces all instance of default WordPress search - search forms etc with a popup of instant search. You can customize the appearance of the search by going to appearance > customize > Typesense Search
To add a custom trigger - you can add the class \"cm-swt-instant-search-popup--trigger\" to your button / svg / anchor tag to trigger the popup Something like the following:
<a href=\"#\" class=\"cm-swt-instant-search-popup--trigger cm-swt-instant-search-popup--trigger-default\"><svg xmlns=\"http://www.w3.org/2000/svg\" class=\"h-6 w-6\" fill=\"none\" viewBox=\"0 0 24 24\" stroke=\"currentColor\" stroke-width=\"2\">\n <path stroke-linecap=\"round\" stroke-linejoin=\"round\" d=\"M21 21l-6-6m2-5a7 7 0 11-14 0 7 7 0 0114 0z\" />\n</svg></a>\nReplaces all search forms with Autocomplete. See example here https://typesense.codemanas.com/autocomplete/
"},{"location":"shortcode/","title":"Shortcodes","text":""},{"location":"shortcode/#instant-search","title":"Instant Search","text":""},{"location":"shortcode/#shortcode","title":"Shortcode","text":"[cm_typesense_search post_types=\"book,post\" columns=\"3\" filter=\"show\" per_page=\"3\" sortby=\"off\" placeholder=\"Search for...\" selected_filters=\"show\" stats=\"show\" routing=\"enable\"]\n Values: Any String Description: Determines the placeholder for search field Default: \"Search for\" "},{"location":"shortcode/#columns","title":"columns","text":" Values: 1 to 5 Description: Determines how may results to show per row Default: 3 "},{"location":"shortcode/#post_types","title":"post_types","text":" Values: Post Slugs e.g. post,page,book Description: accepts enabled post_type slugs to show in instant search, accepts multiple slugs in comma separated form post,page,slug If multiple sources are enabled - filtering is disabled. Default: All enabled post_types "},{"location":"shortcode/#filter","title":"filter","text":" Values: show or hide Description: accepts \"show\" or \"hide\" - determines if facet/category filtering should be shown. Default: hide "},{"location":"shortcode/#per_page","title":"per_page","text":" Description: Determines no of possible/matched results to show per_page Default: 3 "},{"location":"shortcode/#sortby","title":"sortby","text":" Values: show or hide Description: Determines whether to provide a sorting option - by default sorting option is according to post published Default: show "},{"location":"shortcode/#pagination","title":"pagination","text":" Values: show or infinite or hide Description: Determines whether to show or hide the pagination for results, select infinite for load more implementation Default: show "},{"location":"shortcode/#query_by","title":"query_by","text":" Values: string (Advanced Usage the typesense documentation) Description: Query results by these fields Default: post_title,post_content "},{"location":"shortcode/#sticky_first","title":"sticky_first","text":" Values: yes or no Description: Show sticky posts first ? Default: no "},{"location":"shortcode/#custom_class","title":"custom_class","text":" Values: comma separated string of html class my-custom-class-1,my-custom-class-2 Description: Ability to add custom class Default: empty "},{"location":"shortcode/#selected_filters","title":"selected_filters","text":" Values: show or hide Description: Shows the selected filters Default: show "},{"location":"shortcode/#stats","title":"stats","text":" Values: show or hide Description: Shows or hide the number of search results retrieved Default: show "},{"location":"shortcode/#routing","title":"routing","text":" Values: enable or disable Description: Enable or Disable routing feature - this adds the selected search query / facets / filters of the current searches being made to the browser URL. Allowing users to share the current search state. Default: disable "},{"location":"shortcode/#autocomplete","title":"Autocomplete","text":""},{"location":"shortcode/#shortcode_1","title":"Shortcode","text":"[cm_typesense_autocomplete placeholder=\"Search for...\"\"]\nDescription: Add the Autocomplete form wherever you may want to. There are no other options.
"},{"location":"shortcode/#options_1","title":"Options:","text":""},{"location":"shortcode/#placeholder_1","title":"placeholder","text":" Values: Any String Description: Determines the placeholder for search field Default: \"Search for\" "},{"location":"shortcode/#query_by_1","title":"query_by","text":" Values: Any String Description: Determines the search query Default: post_title,post_content "},{"location":"template-overriding/","title":"Overriding Template","text":"Overriding the template allows you to change things of the output for your autocomplete or instant search design as you need to.
Plugin base folder: search-with-typesense/templates The templates are in the plugin search-with-typesense/templates and you can override it by copying it to your child theme.
To override, copy files from wp-content/plugins/search-with-typesense/templates/ folder to wp-content/themes/your-theme/search-with-typesense/,
Then you can make the changes as you need. Copy the file main-panel.php from wp-content/plugins/search-with-typesense/templates/instant-search/main-panel.php to wp-content/themes/your-theme/search-with-typesense/instant-search/main-panel.php.
"},{"location":"tsfwc/","title":"Introduction","text":"Typsense Search for WooCommerce is a premimum addon that provides robust, fast search functionality for WooCommerce products on your website.
"},{"location":"tsfwc/#features","title":"Features","text":" Lightning-fast products search results in miliseconds Allow to override WooCommerce product search Allow to hijack WooCommerce shop and archive pages Provides result in WooCommerce default HTML structure Provides all the features for search and filter provided by WooCommerce but in a better and fast way Provides shortcodes for adding search in only specific locations. Hooks and filters for customizations Template Override for design customizations. "},{"location":"tsfwc/#minimum-requirements","title":"Minimum Requirements","text":" PHP 7.4 required or greater MySQL 5.6 or greater is recommended Search with Typsense WooCommerce "},{"location":"tsfwc/#installation","title":"Installation","text":" After purchasing from Codemanas, download the zip file Then on your site's dashboard, go to WordPress Plugins > Add New > Search for \"Search with Typesense\" Click Install and then activate Plugin "},{"location":"tsfwc/#getting-started","title":"Getting started","text":""},{"location":"tsfwc/#activate-license","title":"Activate License","text":"After activating the plugin, go to Typesense->Addons, then activate the license.
"},{"location":"tsfwc/#indexing-products","title":"Indexing products","text":"First you need to index i.e. push data to Typsense cloud. To do so, follow the below steps:
Go to Typsense->Typesense Select the Products post type from the dropdown in Select Posts Types to Enable Then you can set the Products' label and max suggetion to be listed on autocomplete. After that, click the Index button to index. It may take few minutes depending upon the number of products you have. When the indexing is complete, you will get the success message and process is complete.
"},{"location":"tsfwc/#settings","title":"Settings","text":"The plugin provides the following default settings at Typesense->WooCommerce:
Hijack Shop page - Hijack shop page listing by the instant search
Filters
Enable category - Enable category filtering Enable price - Enable price filtering Enable rating - Enable filtering by rating Enable attributes - Enable filter by attributes Enable sortby - Enable sortby Pagination - Enable pagination
Routing - Enabling this option will activate routing, allowing you to share the URL with the applied filter.
Show featured products first - Display featured products first while filtering or searching products
Search placeholder - Change placeholder text on the shop's search
Hijack Product Search - Hijack WooCommerce search widget and block with Autocomplete.
Note: Same settings are provided in Dashboard->Customize then WooCommerce->Typesense Settings for previewing the live changes.
"},{"location":"tsfwc/#shortcodes","title":"Shortcodes","text":""},{"location":"tsfwc/#instant-search","title":"Instant search","text":"Displays the instant search with products.
[cm_tsfwc_search cat_filter='show' price_filter='show' rating_filter='show' attribute_filter='show' pagination='show' sortby='show' placeholder='Search products...' show_featured_first='no']
"},{"location":"tsfwc/#options","title":"Options:","text":"cat_filter
Value: show or hide Description: Determines the showing or hiding of the category filter Default value: \"show\" price_filter
Value: show or hide Description: Determines the showing or hiding of the price filter Default value: \"show\" rating_filter
Value: show or hide Description: Determines the showing or hiding of the rating filter Default value: \"show\" attribute_filter
Value: show or hide Description: Determines the showing or hiding of the attribute filter Default value: \"show\" pagination
Value: show or hide Description: Determines the showing or hiding of pagination Default value: \"show\" routing
Value: enalbe or disable Description: Enabling this will activate routing, allowing you to share the URL with the applied filter. Default value: \"disable\" sortby
Value: show or hide Description: Determines the showing or hiding of the sortby filter Default value: \"show\" placeholder
Value: Any string Description: Placeholder text for the search input field Default value: \"Search products\" show_featured_first
Value: yes or no Description: Show the featured products first on the listing while searching or filtering Default value: \"no\" query_by
Values: string (Advanced Usage the typesense documentation) Description: Query results by these fields Default: post_title,post_content "},{"location":"tsfwc/#autocomplete-search","title":"Autocomplete search","text":"Displays the autocomplete form to search products.
[cm_tsfwc_autocomplete_search placeholder=\"Search products\"]
"},{"location":"tsfwc/#options_1","title":"Options:","text":"placeholder
Value: string Description: Placeholder text for the search form Default value: empty "},{"location":"tsfwc/#template-overwriting","title":"Template Overwriting","text":"Overriding the template allows you to change the output for the product listing design as you need to.
The templates are in the plugin typesense-search-for-woocommerce/templates and you can override it by copying it to your theme.
To override, copy files from wp-content/plugins/typesense-search-for-woocommerce/templates/ folder to wp-content/themes/your-theme/search-with-typesense/woocommerce. Then you can make the changes as you need.
For example: if you want the filters to show up on the right instead of the left.
Copy the file instant-search.php from typesense-search-for-woocommerce/templates/instant-search.php to your-theme/search-with-typesense/woocommerce/instant-search.php.
And change the div structure so that filter-panel is after main-panel.
End result:
"},{"location":"tsfwc/#action-hooks-filter-hooks-extending-plugin","title":"Action Hooks & Filter Hooks / Extending Plugin","text":"There are plenty of Hooks and Filters provided by the plugin to allow developers to customize or add additional functionality to the plugin
"},{"location":"tsfwc/#filter-hooks","title":"Filter Hooks:","text":"Please see https://developer.wordpress.org/plugins/hooks/filters/ for details of what filters are in WordPress.
cm_tsfwc_per_page_config
Description: Change the per page listing and values Arguments: $per_page_config Array of configs with label and value Default value: [\n [ 'label' => 'Per page', 'value' => $atts['per_page'], 'default' => true ],\n [ 'label' => '10 per page', 'value' => 10 ],\n [ 'label' => '20 per page', 'value' => 20 ],\n [ 'label' => '30 per page', 'value' => 30 ],\n [ 'label' => '40 per page', 'value' => 40 ],\n [ 'label' => '50 per page', 'value' => 50 ],\n ]\ncm_tsfwc_product_fields
Description: Add new fields to schema to be indexed. Arguments: $product_fields Array of fields to be indexed. cm_tsfwc_data_before_entry
Description: Add the formatted data to the added fields. Arguments: $formatted_data Array of data to be returned.$raw_data Raw data containing product object $object_id Object ID passed$schema_name Name of the schema which is product in this case. "},{"location":"tsfwc/#action-hooks","title":"Action Hooks:","text":"Please see https://developer.wordpress.org/plugins/hooks/actions/ for details of what action hooks are in WordPress.
cm_tsfwc_custom_attributes
Description: Hook to add custom attributes HTML to the structure Location: templates/instant-search.php "},{"location":"tsfwc/#change-per-page-dropdown-values-on-frontend","title":"Change per page dropdown values on frontend","text":""},{"location":"tsfwc/#use-case","title":"Use Case:","text":"What if you want to change the 10 per page, 20 per page and so on value to your own custom, let's say 50 per page, 100 per page and so on.
"},{"location":"tsfwc/#how-to-do-it","title":"How to do it:","text":"The plugin provides a filter: cm_tsfwc_per_page_config to change it.
You can use it like below:
add_filter( 'cm_tsfwc_per_page_config', 'your_slug_change_per_page' );\n\nfunction your_slug_change_per_page( $per_page_config ) {\n $per_page_config = [\n [ 'label' => '50 per page', 'value' => 50, 'default' => true ], // one value should always have 'default' => true\n [ 'label' => '100 per page', 'value' => 100 ],\n [ 'label' => '150 per page', 'value' => 150 ],\n [ 'label' => '200 per page', 'value' => 200 ],\n ];\n return $per_page_config;\n}\nSuppose you want to add tags ( or any other custom taxonomy ) filter to the shop/archive page other than the default ones provided by the addon.
"},{"location":"tsfwc/#how-to-do-it_1","title":"How to do it:","text":""},{"location":"tsfwc/#format-the-document-data-to-be-indexed-as-facet","title":"Format the document data to be indexed as Facet","text":"To add a new Facet you need to add it as .*_attribute_filter, so if you want to add product_tags you can add it as product_tags_attribute_filter
add_filter( 'cm_tsfwc_data_before_entry', 'your_slug_add_data_before_entry', 10, 4 );\n\nfunction your_slug_add_data_before_entry( $formatted_data, $raw_data, $object_id, $schema_name ) {\n\n if( $schema_name === 'product' ) { // only add data if the schema is product \n\n $product_tags = get_the_terms( $object_id, 'product_tag' );\n\n $product_tags_arr = [];\n\n if( ! is_wp_error( $product_tags ) ) {\n foreach( $product_tags as $product_tag ) {\n $product_tags_arr[] = $product_tag->name;\n }\n } else {\n $product_tags_arr = []; // Only array can be pushed to the data. When no data, empty array is the must\n }\n\n $formatted_data['product_tags_attribute_filter'] = $product_tags_arr;\n }\n\n return $formatted_data;\n\n}\n\nTo display the filter on the frontend, use the action hook cm_tsfwc_custom_attributes like below:
add_action( 'cm_tsfwc_custom_attributes', 'your_slug_add_custom_attr' );\n\nfunction your_slug_add_custom_attr() {\n echo '<div \n data-facet_name=\"product_tags_attribute_filter\" \n data-title =\"' . __( \"Filter by Tags\", 'storefront' ) . '\" \n class=\"cm-tsfwc-shortcode-tags-attribute-filters\" \n data-filter_type=\"refinementList\"\n data-settings=\"' . _wp_specialchars( json_encode( [ \"searchable\" => false ] ), ENT_QUOTES, \"UTF-8\", true ) . '\"\n ></div>';\n}\n\n data-facet_name: It should same as the name of the field added before. For example: here name of the field added before is 'product_tags_attribute_filter' so the data-facet_name should be product_tags_attribute_filter
data-title: Title for the filter
data-filter_type: Type of filter to use
"},{"location":"tsfwc/#adding-static-code-widgets-to-the-sidebar","title":"Adding static code / widgets to the sidebar","text":""},{"location":"tsfwc/#use-case_2","title":"Use Case:","text":"Suppose you want to add default WooCommerce widgets like Top Rated Products below the filters
"},{"location":"tsfwc/#how-to-do-it_2","title":"How to do it:","text":""},{"location":"tsfwc/#use-cm_tsfwc_filter_panel_output-hook","title":"Use cm_tsfwc_filter_panel_output hook","text":"add_action( 'cm_tsfwc_filter_panel_output', 'mytheme_add_widgets',40 );\n\nfunction mytheme_add_widgets() {\n the_widget( 'WC_Widget_Top_Rated_Products' );\n}\n\nSuppose you want to remove Filter by size filter.
"},{"location":"tsfwc/#use-cm_tsfwc_attribute_facet_skip-hook","title":"Use cm_tsfwc_attribute_facet_skip hook","text":"add_filter( 'cm_tsfwc_attribute_facet_skip', 'mytheme_hide_attribute_facet' );\n\nfunction mytheme_hide_attribute_facet() {\n return ['book-author'];\n}\nfunction your_slug_change_cat_filter_type( $filterType ) {\n\n $filterType = 'menu';\n\n return $filterType;\n}\n\nadd_filter( 'cm_tsfwc_category_filter_type', 'your_slug_change_cat_filter_type' );\n** Acceptable filter type = refinementList, menu **
"},{"location":"tsfwc/#changing-type-of-widget-in-price-filter","title":"Changing type of widget in Price filter","text":"function your_slug_change_price_filter_type( $filterType ) {\n\n $filterType = 'rangeSlider';\n\n return $filterType;\n}\n\nadd_filter( 'cm_tsfwc_price_filter_type', 'your_slug_change_price_filter_type' );\n** Acceptable filter type = rangeSlider, rangeInput **
"},{"location":"tsfwc/#changing-type-of-widget-in-rating-filter","title":"Changing type of widget in Rating filter","text":"function your_slug_change_rating_filter_type( $filterType ) {\n\n $filterType = 'rangeSlider';\n\n return $filterType;\n}\n\nadd_filter( 'cm_tsfwc_rating_filter_type', 'your_slug_change_rating_filter_type' );\n** Acceptable filter type = ratingMenu, rangeSlider, rangeInput **
"},{"location":"tsfwc/#changing-type-of-widget-in-attribute-filters","title":"Changing type of widget in Attribute filters","text":"function your_slug_change_attribute_filter_type( $filterType, $attributeName ) {\n\n if ( $attributeName == 'size' ) {\n $filterType = 'menu';\n }\n\n return $filterType;\n}\n\nadd_filter( 'cm_tsfwc_attribute_filter_type', 'your_slug_change_attribute_filter_type', 10, 2 );\n** Acceptable filter type = refinementList, menu rangeInput, rangeSlider **
Note: For rangeSlider and rangeInput the schema for field must be int64
"},{"location":"tsfwc/#addingchanging-facets-settings","title":"Adding/changing facets settings","text":""},{"location":"tsfwc/#changing-facet-settings-in-category-filter","title":"Changing facet settings in Category filter","text":"function your_slug_change_facet_setting( $filterSettings ) {\n\n $filterSettings = [ 'searchable' => true ];\n\n return $filterSettings;\n}\n\nadd_filter( 'cm_tsfwc_category_facet_settings', 'your_slug_change_facet_setting' );\nSee here for available options.
Note: container and attribute are not overridable
"},{"location":"tsfwc/#changing-facet-settings-in-price-filter","title":"Changing facet settings in Price filter","text":"function your_slug_change_facet_setting( $filterSettings ) {\n\n $filterSettings = [ 'pips' => false ];\n\n return $filterSettings;\n}\n\nadd_filter( 'cm_tsfwc_price_facet_settings', 'your_slug_change_facet_setting' );\nSee here for available options.
Note: container and attribute are not overridable
"},{"location":"tsfwc/#changing-facet-settings-in-rating-filter","title":"Changing facet settings in Rating filter","text":"function your_slug_change_facet_setting( $filterSettings ) {\n\n $filterSettings = [ 'max' => 5 ];\n\n return $filterSettings;\n}\n\nadd_filter( 'cm_tsfwc_rating_facet_settings', 'your_slug_change_facet_setting' );\nSee here for available options.
"},{"location":"tsfwc/#changing-facet-settings-in-custom-attribute-filter","title":"Changing facet settings in Custom Attribute filter","text":"function your_slug_change_facet_setting( $filterSettings, $attrName ) {\n\n if( 'color' == $attrName ) {\n $filterSettings = [ 'searchable' => true ];\n }\n\n return $filterSettings;\n}\n\nadd_filter( 'cm_tsfwc_attribute_facet_settings', 'your_slug_change_facet_setting', 10, 2 );\nSee here for available options.
Note: container and attribute are not overridable
"},{"location":"tsfwc/#wpml-integration","title":"WPML Integration","text":"As of version 1.2.4 of Typesense search for WooCommerce - the plugin is compatible with WPML and adds features to integrate with WPML + WooCommerce The plugins required for WPML Integration are :
"},{"location":"tsfwc/#pre-requisites","title":"Pre-requisites","text":" WooCommerce Multilingual WPML 4.4.11 or aboves WPML String Translation WPML Translation Management (not needed for WooCommerce 3.9.0) Typesense Search for WooCommerce If you want to use different media (images) for different translations of a product, you need to install WPML Media.
"},{"location":"tsfwc/#wpml-translation-modes-and-tools","title":"WPML Translation modes and tools","text":"There are two different translation modes while using WPML. Please see WPML documentation for detailed information.
Translate Everything : All of the site\u2019s main content will be automatically translated into all secondary languages as content is published or updated. Translations can then be reviewed on the front-end and edited by the user (or local translator) if needed. Translate Some : Users can pick and choose what to translate, when to translate it, and who will translate it. This mode allows for content to be translated manually, translated via WPML\u2019s Advanced Translation Editor, translated by professional translation services , or even translated by a team of local translators. "},{"location":"tsfwc/#translating-content","title":"Translating Content:","text":"For translation of content - there is nothing new you need to do on the typesense plugin. Based on your setup the WooCommerce Products, Pages (checkout, cart, my-account etc), translations are handled by the WooCommerce Multilingual plugin - please see translating products
What is required for Typesense integration is only on initial installation. You would need to index your products for each language you have.
"},{"location":"tsfwc/#indexing-products_1","title":"Indexing Products:","text":"To index products you will need to go to WP Admin > Typesense Here you will be shown the Typesense Search Config settings and you can index the products. The only difference here is to switch language on your admin screen for each of your language to index your products. This step - is a one time step - meaning it only needs to be done once - when the plugin is initially configured. Please see video for a small walk through.
Once the indexing is complete, all your current products will show up in the shop and users will be show the products based on the current language the user has selected. For new products - they will be indexed to the correct translation - when they are added / updated. And will be removed if they are deleted / status visibility of product is changed.
"},{"location":"tsfwc/#translating-plugin-strings","title":"Translating Plugin Strings","text":"Some strings are hardcoded into the plugin and will require string translation. You can see detailed documentation for string translation here. Please see this short video on how to translate strings.
Note: container and attribute are not overridable
"},{"location":"tsfwc/#making-category-menu-filter-a-hierarchical-menu","title":"Making category menu filter a hierarchical menu","text":"Hierarchical menu is a navigaton based on a hierarchy of attributes like category and it's subcategories. See below for example:
From version 1.3.5, we have added an option to change the defalut category menu filter to hierarchical menu. Follow the below steps:
Go to Dashboard -> Typesense -> WooCommerce In Advance Settings, enable the Make the default Category filter hierarchical menu Click Save Changes button After saving, you need to Delete and Re-index your Products from Typesense->Typesense in Search Configuration tab. Please note that enabling this option will be resource heavy and may make your backend slow.
This is because WooCommerce does not provide the default hierarchy of the products' categories and subcategories. So we have to manually query all the categoires and make a hierarchy which in itself is a heavy process. Further more, on adding, updating and deleting of a category, we have to repeat the proess and index again.
"},{"location":"tsfwc/#additional-search-parameters-for-default-search-configuration","title":"Additional search parameters for default search configuration","text":"From version 1.3.7, you can configure additional search parameters for both Instant search and Autocomplete using the filter hooks mentioned below:
cm_tsfwc_additional_search_params - Configure instant search additional search parameters
cm_tsfwc_additional_autocomplete_params - Configure autocomplete search additional search parameters
Example code:
add_filter( 'cm_tsfwc_additional_search_params', 'theme_slug_alter_search_params' );\nfunction theme_slug_alter_search_params() {\n return [\n 'hidden_hits' => 3662,\n // 'query_by_weights' => '1,2', \n // 'query_by' => \"post_content,post_title\",\n // 'sort_by' => 'total_sales:asc', // work only with numerical fields\n // 'filter_by' => 'post_title: test',\n // 'facet_by' => 'category,prices', // can not override so dont work\n // 'max_facet_values' => 1, // can not override so don't work\n // 'facet_query' => 'category_lvl0: Alaram',\n // 'num_typos' => 2,\n // 'page' => 2, // cannot override so don't work\n // 'group_by' => 'category',\n // 'highlightFullFields' => 'post_title,post_content,test',\n // 'include_fields' => 'price,prices',\n // 'pinned_hits' => '3662:2',\n ];\n}\nYou can refer here: https://typesense.org/docs/0.23.1/api/search.html#search-parameters for additional parameters.
Note: Some parameters like facet_by, q, max_facet_values, page can not be overwritten. Others can be passed as required.
"},{"location":"tsfwc/#search-only-after-certain-character-length","title":"Search only after certain character length","text":"From version 1.4.8, you can configure search to be triggered after certain characters are typed on search bar. The new filter introduced is cm_tsfwc_search_query_length
You can use the hook like below. The below code triggers search only when 4 character is typed on search bar:
add_filter( 'cm_tsfwc_search_query_length', 'your_slug_serach_after_char_count' ); \n\nfunction your_slug_serach_after_char_count( $count ) {\n $count = 4;\n return $count;\n}\n\nBy default, the schema of page gets the same schema as post. That means page will also have category and cat_links in it's schema. But that is redundent since page does not have categories. So those fields should be removed from page's schema.
To remove the fields, paste the below code in your theme's functions.php
add_filter( 'cm_typesense_schema', 'remove_cat_facet_from_page', 10, 2 );\n\n function remove_cat_facet_from_page( $schema, $name ) {\n if ( $name == 'page' ) {\n foreach( $schema['fields'] as $index => $field ) {\n if( 'category' == $field['name'] || 'cat_link' == $field['name'] ) {\n unset( $schema['fields'][ $index ]);\n } \n }\n }\n\n // Should be sorted because unset removes the index number only and leave empty in between\n sort( $schema['fields']);\n return $schema;\n}\nNote: After implementing this, page has to be reindexed by clicking Delete and Re-index on settings page
"},{"location":"wp-cli/","title":"WP CLI","text":""},{"location":"wp-cli/#wp-cli","title":"WP CLI","text":"WP-CLI serves as the command-line interface for WordPress, offering a range of commands for various actions typically executed in the WordPress admin.
Within the framework of the Search With Typesense plugin, our plugin introduces its own set of WP-CLI commands. These commands enable you to index and delete post types, with the flexibility to specify particular IDs. Additionally, the plugin provides an option to assess the health status of the Typesense server.
This is very helpful if you have command line access to your WordPress installation instace on your server.
Kindly be aware that the subsequent commands will not remove your posts from the WordPress database. Instead, these commands exclusively index or delete the posts on your Typesense Server.
Note: We intend to incorporate additional commands in the future based on your requests. Your feedback would be highly valuable.
"},{"location":"wp-cli/#supported-commands","title":"Supported Commands","text":""},{"location":"wp-cli/#wp-typesense-index","title":"wp typesense index","text":"Index a specific post type to Typesense server
"},{"location":"wp-cli/#options","title":"Options","text":" Slug of the post type you want to index.
[--ids=]
The comma separated IDs of the posts of that post type you want to index.
"},{"location":"wp-cli/#examples","title":"Examples","text":"# Index all the default posts\n$ wp typesense index post\n# Index all only specific posts with IDs: 2,3 and 4 for the custom post type 'books'\n$ wp typesense index books --ids=2,3,4\nDelete a specific post type from Typesense server
"},{"location":"wp-cli/#options_1","title":"Options","text":"
Slug of the post type you want to delete.
[--ids=]
The comma separated IDs of the posts of that post type you want to delete.
"},{"location":"wp-cli/#examples_1","title":"Examples","text":"# delete all the default posts\n$ wp typesense delete post\n# delete all only specific posts with IDs: 2,3 and 4 for the custom post type 'books'\n$ wp typesense delete books --ids=2,3,4\nCheck the health status of your Typesense server.
"},{"location":"wp-cli/#examples_2","title":"Examples","text":"$ wp typesense health\n PHP 7.4 required or greater MySQL 5.6 or greater is recommended "},{"location":"#automatic-installation","title":"Automatic Installation","text":" Go to WordPress Plugins > Add New Search for \"Search with Typesense\" Click Install and then activate Plugin "},{"location":"#manual-installation","title":"Manual Installation","text":"If for some reason automatic installation is not possible, go to https://wordpress.org/plugins/search-with-typesense/ and you will see the download button. Clicking download button will provide you with a zip file of the plugin then.
Go to WordPress Plugins > Add New and click upload plugin. Click upload plugin and then add the zip file The plugin will then be installed, then activate the plugin. "},{"location":"advanced-custom-post-types/","title":"Adding Custom Post Type","text":""},{"location":"advanced-custom-post-types/#introduction","title":"Introduction","text":"By default, the plugin supports posts and pages for indexing. Adding additional / custom post types can be achieve via filter hooks. There are three things you should be aware of.
Adding the custom post type to available post types for indexing Adding schema for your custom post type Formatting data before documents are added For this guide - we have assumed that the custom post type is book, please note that the slug of custom post type is quite important.
/**\n * Register a custom post type called \"book\".\n *\n * @see get_post_type_labels() for label keys.\n */\nfunction wp_docs_codex_book_init() {\n $labels = array(\n 'name' => _x( 'Books', 'Post type general name', 'textdomain' ),\n 'singular_name' => _x( 'Book', 'Post type singular name', 'textdomain' ),\n 'menu_name' => _x( 'Books', 'Admin Menu text', 'textdomain' ),\n 'name_admin_bar' => _x( 'Book', 'Add New on Toolbar', 'textdomain' ),\n 'add_new' => __( 'Add New', 'textdomain' ),\n 'add_new_item' => __( 'Add New Book', 'textdomain' ),\n 'new_item' => __( 'New Book', 'textdomain' ),\n 'edit_item' => __( 'Edit Book', 'textdomain' ),\n 'view_item' => __( 'View Book', 'textdomain' ),\n 'all_items' => __( 'All Books', 'textdomain' ),\n 'search_items' => __( 'Search Books', 'textdomain' ),\n 'parent_item_colon' => __( 'Parent Books:', 'textdomain' ),\n 'not_found' => __( 'No books found.', 'textdomain' ),\n 'not_found_in_trash' => __( 'No books found in Trash.', 'textdomain' ),\n 'featured_image' => _x( 'Book Cover Image', 'Overrides the \u201cFeatured Image\u201d phrase for this post type. Added in 4.3', 'textdomain' ),\n 'set_featured_image' => _x( 'Set cover image', 'Overrides the \u201cSet featured image\u201d phrase for this post type. Added in 4.3', 'textdomain' ),\n 'remove_featured_image' => _x( 'Remove cover image', 'Overrides the \u201cRemove featured image\u201d phrase for this post type. Added in 4.3', 'textdomain' ),\n 'use_featured_image' => _x( 'Use as cover image', 'Overrides the \u201cUse as featured image\u201d phrase for this post type. Added in 4.3', 'textdomain' ),\n 'archives' => _x( 'Book archives', 'The post type archive label used in nav menus. Default \u201cPost Archives\u201d. Added in 4.4', 'textdomain' ),\n 'insert_into_item' => _x( 'Insert into book', 'Overrides the \u201cInsert into post\u201d/\u201dInsert into page\u201d phrase (used when inserting media into a post). Added in 4.4', 'textdomain' ),\n 'uploaded_to_this_item' => _x( 'Uploaded to this book', 'Overrides the \u201cUploaded to this post\u201d/\u201dUploaded to this page\u201d phrase (used when viewing media attached to a post). Added in 4.4', 'textdomain' ),\n 'filter_items_list' => _x( 'Filter books list', 'Screen reader text for the filter links heading on the post type listing screen. Default \u201cFilter posts list\u201d/\u201dFilter pages list\u201d. Added in 4.4', 'textdomain' ),\n 'items_list_navigation' => _x( 'Books list navigation', 'Screen reader text for the pagination heading on the post type listing screen. Default \u201cPosts list navigation\u201d/\u201dPages list navigation\u201d. Added in 4.4', 'textdomain' ),\n 'items_list' => _x( 'Books list', 'Screen reader text for the items list heading on the post type listing screen. Default \u201cPosts list\u201d/\u201dPages list\u201d. Added in 4.4', 'textdomain' ),\n );\n\n $args = array(\n 'labels' => $labels,\n 'public' => true,\n 'publicly_queryable' => true,\n 'show_ui' => true,\n 'show_in_menu' => true,\n 'query_var' => true,\n 'rewrite' => array( 'slug' => 'book' ),\n 'capability_type' => 'post',\n 'has_archive' => true,\n 'hierarchical' => false,\n 'menu_position' => null,\n 'supports' => array( 'title', 'editor', 'author', 'thumbnail', 'excerpt', 'comments' ),\n );\n\n register_post_type( 'book', $args );\n}\n\nadd_action( 'init', 'wp_docs_codex_book_init' );\n/**\n * Create two taxonomies, genres and writers for the post type \"book\".\n *\n * @see register_post_type() for registering custom post types.\n */\nfunction wp_docs_create_book_taxonomies() {\n // Add new taxonomy, make it hierarchical (like categories)\n $labels = array(\n 'name' => _x( 'Genres', 'taxonomy general name', 'textdomain' ),\n 'singular_name' => _x( 'Genre', 'taxonomy singular name', 'textdomain' ),\n 'search_items' => __( 'Search Genres', 'textdomain' ),\n 'all_items' => __( 'All Genres', 'textdomain' ),\n 'parent_item' => __( 'Parent Genre', 'textdomain' ),\n 'parent_item_colon' => __( 'Parent Genre:', 'textdomain' ),\n 'edit_item' => __( 'Edit Genre', 'textdomain' ),\n 'update_item' => __( 'Update Genre', 'textdomain' ),\n 'add_new_item' => __( 'Add New Genre', 'textdomain' ),\n 'new_item_name' => __( 'New Genre Name', 'textdomain' ),\n 'menu_name' => __( 'Genre', 'textdomain' ),\n );\n\n $args = array(\n 'hierarchical' => true,\n 'labels' => $labels,\n 'show_ui' => true,\n 'show_admin_column' => true,\n 'query_var' => true,\n 'rewrite' => array( 'slug' => 'genre' ),\n );\n\n register_taxonomy( 'genre', array( 'book' ), $args );\n\n unset( $args );\n unset( $labels );\n\n // Add new taxonomy, NOT hierarchical (like tags)\n $labels = array(\n 'name' => _x( 'Writers', 'taxonomy general name', 'textdomain' ),\n 'singular_name' => _x( 'Writer', 'taxonomy singular name', 'textdomain' ),\n 'search_items' => __( 'Search Writers', 'textdomain' ),\n 'popular_items' => __( 'Popular Writers', 'textdomain' ),\n 'all_items' => __( 'All Writers', 'textdomain' ),\n 'parent_item' => null,\n 'parent_item_colon' => null,\n 'edit_item' => __( 'Edit Writer', 'textdomain' ),\n 'update_item' => __( 'Update Writer', 'textdomain' ),\n 'add_new_item' => __( 'Add New Writer', 'textdomain' ),\n 'new_item_name' => __( 'New Writer Name', 'textdomain' ),\n 'separate_items_with_commas' => __( 'Separate writers with commas', 'textdomain' ),\n 'add_or_remove_items' => __( 'Add or remove writers', 'textdomain' ),\n 'choose_from_most_used' => __( 'Choose from the most used writers', 'textdomain' ),\n 'not_found' => __( 'No writers found.', 'textdomain' ),\n 'menu_name' => __( 'Writers', 'textdomain' ),\n );\n\n $args = array(\n 'hierarchical' => false,\n 'labels' => $labels,\n 'show_ui' => true,\n 'show_admin_column' => true,\n 'update_count_callback' => '_update_post_term_count',\n 'query_var' => true,\n 'rewrite' => array( 'slug' => 'writer' ),\n );\n\n register_taxonomy( 'writer', 'book', $args );\n}\n\n// hook into the init action and call create_book_taxonomies when it fires\nadd_action( 'init', 'wp_docs_create_book_taxonomies', 0 );\nTo add custom post types, cm_typesense_available_index_types needs to be used like below:
function cm_typesense_add_available_post_types( $available_post_types ) {\n $available_post_types['book'] = [ 'label' => 'Book', 'value' => 'book' ];\n\n return $available_post_types;\n}\nadd_filter( 'cm_typesense_available_index_types', 'cm_typesense_add_available_post_types');\n\nNote: This hook is available since version 1.3.0. Before version 1.3.0, cm_typesense_available_post_types needs to be used for the purspose.
This will add your custom post type to the available post types dropdown in the backend. Which will allow you to enable the post type and index it.
IMPORTANT NOTE: Please note the index and value MUST be the post_slug
Result:
"},{"location":"advanced-custom-post-types/#adding-schema","title":"Adding Schema","text":"Your schema for the custom post type would most likely need to be different for your custom post type. For example you may want to send custom taxonomies as facets for your post type. To do so you will need to modify / add your schema - BEFORE - any indexing is done
IMPORTANT NOTE: SCHEMA NEEDS TO BE DEFINED BEFORE COLLECTION IS CREATED.
//only necessary if the default post schema is not necessary\nfunction cm_typesense_add_book_schema( $schema, $name ) {\n if ( $name == 'book' ) {\n $schema = [\n 'name' => 'book',\n 'fields' => [\n [ 'name' => 'post_content', 'type' => 'string' ],\n [ 'name' => 'post_title', 'type' => 'string' ],\n [ 'name' => 'post_type', 'type' => 'string' ],\n [ 'name' => 'post_author', 'type' => 'string' ],\n [ 'name' => 'comment_count', 'type' => 'int64' ],\n [ 'name' => 'is_sticky', 'type' => 'int32' ],\n [ 'name' => 'post_excerpt', 'type' => 'string' ],\n [ 'name' => 'post_date', 'type' => 'string' ],\n [ 'name' => 'post_id', 'type' => 'string' ],\n [ 'name' => 'post_modified', 'type' => 'string' ],\n [ 'name' => 'id', 'type' => 'string' ],\n [ 'name' => 'permalink', 'type' => 'string' ],\n [ 'name' => 'post_thumbnail', 'type' => 'string' ],\n [ 'name' => 'genre', 'type' => 'string[]', 'facet' => true ]\n ],\n 'default_sorting_field' => 'comment_count'\n ];\n }\n\n\n return $schema;\n}\n\nadd_filter( 'cm_typesense_schema', 'cm_typesense_add_book_schema', 10, 2 );\nIn the example above - you can see genre is being sent as a facet. \"genre\" is the custom taxonomy attached to the book post type.
"},{"location":"advanced-custom-post-types/#formatting-data","title":"Formatting Data","text":"//you can modify the code as needed \n//if your schema is simillar to the default post type then you should only change what fields you need to add\n//example here we are only adding genre\nfunction cm_typesense_format_book_data ( $formatted_data, $raw_data, $object_id, $schema_name ) {\n if ( $schema_name == 'book' ) {\n $terms = get_the_terms( $object_id, 'genre' );\n $genres = [];\n foreach ( $terms as $term ) {\n $genres[] = $term->name;\n }\n $formatted_data['genre'] = $genres;\n }\n\n return $formatted_data;\n}\nadd_filter( 'cm_typesense_data_before_entry', 'cm_typesense_format_book_data', 10, 4 );\nAdding custom or additional taxonomy as a collection. From version 1.3.1 - the plugin adds the default post category as an indexable taxonomy option. To add additional/custom taxonomy - the following steps are required
Add as Available Index Type Add Schema for Custom Taxonomy Format Document Before Entry (optional) This example assumes that you have a custom post type called book, and a custom taxonomy called genre
/**\n * Create genres for the post type \"book\".\n *\n * @see register_post_type() for registering custom post types.\n */\nfunction wp_docs_create_book_taxonomies() {\n // Add new taxonomy, make it hierarchical (like categories)\n $labels = array(\n 'name' => _x( 'Genres', 'taxonomy general name', 'textdomain' ),\n 'singular_name' => _x( 'Genre', 'taxonomy singular name', 'textdomain' ),\n 'search_items' => __( 'Search Genres', 'textdomain' ),\n 'all_items' => __( 'All Genres', 'textdomain' ),\n 'parent_item' => __( 'Parent Genre', 'textdomain' ),\n 'parent_item_colon' => __( 'Parent Genre:', 'textdomain' ),\n 'edit_item' => __( 'Edit Genre', 'textdomain' ),\n 'update_item' => __( 'Update Genre', 'textdomain' ),\n 'add_new_item' => __( 'Add New Genre', 'textdomain' ),\n 'new_item_name' => __( 'New Genre Name', 'textdomain' ),\n 'menu_name' => __( 'Genre', 'textdomain' ),\n );\n\n $args = array(\n 'hierarchical' => true,\n 'labels' => $labels,\n 'show_ui' => true,\n 'show_admin_column' => true,\n 'query_var' => true,\n 'rewrite' => array( 'slug' => 'genre' ),\n );\n\n register_taxonomy( 'genre', array( 'book' ), $args );\n}\n\n// hook into the init action and call create_book_taxonomies when it fires\nadd_action( 'init', 'wp_docs_create_book_taxonomies', 0 );\nThe following code will add the genre option to be selected and configured via Typesense > Typesense admin area. For a taxonomy it is implicitly required to define \"type => taxonomy\".
/** Add the genre option to available index list **/\n function cm_typesense_add_taxonomy( $available_post_types ) {\n $available_post_types['category'] = [ 'label' => 'Post Categories', 'value' => 'category', 'type' => 'taxonomy' ];\n\n return $available_post_types;\n }\n add_filter( 'cm_typesense_available_index_types', 'cm_typesense_add_taxonomy' );\n\nThe following code updates taxonomy - any time changes are made to taxonomy
function cm_typesense_add_taxonomy_for_update( $taxonomies ) {\n $taxonomies[] = 'genre';\n\n return $taxonomies;\n }\n\n add_filter( 'cm_typesense_enabled_taxonomy_for_post_type', 'cm_typesense_add_taxonomy_for_update' );\n*** Make sure the value for genre is the same as slug of the taxonomy. ***
"},{"location":"advanced-custom-taxonomy/#add-schema-for-custom-taxonomy","title":"Add Schema for Custom Taxonomy","text":"You can define - your taxonomy schema as any way you want. But to be compatible with the default autocomplete and instant search templates - please use the following base schema.
function cm_typesense_add_post_category_schema( $schema, $name ) {\n if ( $name == 'genre' ) {\n $schema = [\n 'name' => 'genre',\n 'fields' => [\n [ 'name' => 'term_id', 'type' => 'string' ],\n [ 'name' => 'id', 'type' => 'string' ],\n [ 'name' => 'taxonomy', 'type' => 'string' ],\n [ 'name' => 'post_title', 'type' => 'string' ],\n [ 'name' => 'post_content', 'type' => 'string' ],\n [ 'name' => 'slug', 'type' => 'string' ],\n [ 'name' => 'posts_count', 'type' => 'int64' ],\n [ 'name' => 'permalink', 'type' => 'string' ],\n ],\n 'default_sorting_field' => 'posts_count'\n ];\n }\n\n\n return $schema;\n }\n\nadd_filter( 'cm_typesense_schema', 'cm_typesense_add_post_category_schema', 10, 2 );\nThis step is only required if you are adding additional fields or have modified the schema. For example if schema has a thumbnail that you would like to show. Suppose I have added a post thumbnail field via ACF which return image URL. Then the schema would be
function cm_typesense_add_post_category_schema( $schema, $name ) {\n if ( $name == 'genre' ) {\n $schema = [\n 'name' => 'genre',\n 'fields' => [\n [ 'name' => 'term_id', 'type' => 'string' ],\n [ 'name' => 'id', 'type' => 'string' ],\n [ 'name' => 'taxonomy', 'type' => 'string' ],\n [ 'name' => 'post_title', 'type' => 'string' ],\n [ 'name' => 'post_content', 'type' => 'string' ],\n [ 'name' => 'slug', 'type' => 'string' ],\n [ 'name' => 'posts_count', 'type' => 'int64' ],\n [ 'name' => 'permalink', 'type' => 'string' ],\n ['name'=>'post_thumbnail','type'=>'string']\n ],\n 'default_sorting_field' => 'posts_count'\n ];\n }\n\n\n return $schema;\n }\n\nadd_filter( 'cm_typesense_schema', 'cm_typesense_add_post_category_schema', 10, 2 );\nThen we can add the data the following way
function cm_typesense_format_taxonomy_data_before_entry( $formatted_data, $raw_data, $object_id, $schema_name ) {\n if ( $schema_name == 'genre' ) {\n //only need to add the additional data\n $formatted_data['post_thumbnail'] = get_field( 'image', $raw_data ) ?? CODEMANAS_TYPESENSE_ROOT_URI_PATH . '/assets/placeholder.jpg';\n }\n\n return $formatted_data;\n }\n\n add_filter( 'cm_typesense_data_before_entry', 'cm_typesense_format_taxonomy_data_before_entry', 10, 4 );\nBy default, all facets for filtering are shown as refinementList. As of version 1.2.4 developers have the version to add between menu, rangeSlider or rangeInput.
Note: For rangeSlider and rangeInput the facet must be int64.
To do this you can use filer cm_typesense_filter_type. The following code is written in child themes functions.php file.
function cm_change_facet_widget_type( $filterType, $filterName ) {\n if ( $filterName == 'category' ) {\n $filterType = 'menu';\n } else if ( $filterName == 'comment_count' ) {\n /*For range slider the schema for field must be int64*/\n $filterType = 'rangeSlider';\n }\n\n return $filterType;\n}\n\nadd_filter( 'cm_typesense_filter_type', 'cm_change_facet_widget_type', 10, 2 );\nSuppose you added a new field for instance price in your schema and indexed it to TypeSense server. Now how to show the price in the result template?
To show the price in result tempalte, follow the steps below:
"},{"location":"customizing-default-hit-template/#1-register-a-custom-template-for-your-index-type","title":"1. Register a custom template for your index type","text":"First you have to register the custom template for your index type. The important part here is the id of the template. If you look at the code below, notice the id of the script is tmpl-cmswt-Result-itemTemplate--book. The last part of the id must be value of the index type you are registering with the hook cm_typesense_available_post_types.
<?php\nfunction cm_202208_add_book_hit_template() { ?>\n <script type=\"text/html\" id=\"tmpl-cmswt-Result-itemTemplate--book\">\n <div class=\"hit-header\">\n <# if(data.post_thumbnail !== undefined) { #>\n <a href=\"{{{data._highlightResult.permalink.value}}}\" class=\"hit-header--link\" rel=\"nofollow noopener\">\n <img src=\"{{{data.post_thumbnail}}}\"/>\n </a>\n <# } #>\n </div>\n <div class=\"hit-content\">\n <a href=\"{{{data._highlightResult.permalink.value}}}\" rel=\"nofollow noopener\"><h5 class=\"title\">{{{data.formatted.post_title}}}</h5></a>\n <# if( data.post_type === 'book' ) { #>\n <div class=\"hit-meta\">\n <span class=\"posted-on\">\n <time datetime=\"\">{{data.formatted.postedDate}}</time>\n </span>\n <# if ( Object.keys(data.formatted.cats).length > 0 ) { #>\n <div class=\"hit-cats\">\n <# for ( let key in data.formatted.cats ) { #>\n <div class=\"hit-cat\"><a href=\"{{{data.formatted.cats[key]}}}\">{{{key}}}</a>,</div>\n <# } #>\n </div>\n <# } #>\n <# } #>\n <div class=\"hit-description\">{{{data.formatted.post_content}}}</div>\n <div class=\"hit-link\">\n <a href=\"{{data.permalink}}\"><?php _e( 'Read More...', 'search-with-typesense' ); ?></a>\n </div>\n </div>\n </div>\n </script>\n<?php\n}\nadd_action( 'wp_footer', 'cm_202208_add_book_hit_template' );\nNote: The template above is the default template.
"},{"location":"customizing-default-hit-template/#2-showing-the-custom-field","title":"2. Showing the custom field","text":"In our case we want to show our custom field price, for that we change the above code by adding this line: <span class=\"price\">Price: ${{{data.price}}}</span>
<?php\nfunction your_prefix_custom_hits() {\n ?>\n <script type=\"text/html\" id=\"tmpl-cmswt-Result-itemTemplate--default\">\n <div class=\"hit-header\">\n <# if(data.post_thumbnail !== undefined) { #>\n <a href=\"{{{data._highlightResult.permalink.value}}}\" class=\"hit-header--link\" rel=\"nofollow noopener\">\n <img src=\"{{{data.post_thumbnail}}}\"/>\n </a>\n <# } #>\n </div>\n <div class=\"hit-content\">\n <# if(data._highlightResult.permalink !== undefined ) { #>\n <a href=\"{{{data._highlightResult.permalink.value}}}\" rel=\"nofollow noopener\"><h5 class=\"title\">{{{data.formatted.post_title}}}</h5></a>\n <# } #>\n <# if( data.post_type === 'book' ) { #>\n <div class=\"hit-meta\">\n <span class=\"posted-on\">\n <time datetime=\"\">{{data.formatted.postedDate}}</time>\n </span>\n <span class=\"price\">Price: ${{{data.price}}}</span>\n <# if ( Object.keys(data.formatted.cats).length > 0 ) { #>\n <div class=\"hit-cats\">\n <# for ( let key in data.formatted.cats ) { #>\n <div class=\"hit-cat\"><a href=\"{{{data.formatted.cats[key]}}}\">{{{key}}}</a>,</div>\n <# } #>\n </div>\n <# } #>\n <# } #>\n <div class=\"hit-description\">{{{data.formatted.post_content}}}</div>\n <div class=\"hit-link\">\n <a href=\"{{data.permalink}}\"><?php _e( 'Read More...', 'search-with-typesense' ); ?></a>\n </div>\n </div>\n </div>\n\n </script>\n<?php\n}\nadd_action( 'wp_footer', 'your_prefix_custom_hits' );\nTo debug or see what values are avialable to use, you can add {{console.log(data)}} inside the template and see the available datas.
In our custom example, this will log something like this:
"},{"location":"customizing-instant-search-widgets/","title":"Customizing Instant Search Widgets","text":"Since version 1.1.4 of the plugin two new filters have been added to customize Facets and the sort by widgets
Facets : cm_typesense_search_facet_settings Sort BY : cm_typesense_search_sortby_items "},{"location":"customizing-instant-search-widgets/#facet-customization","title":"Facet Customization","text":"To customize facets you can use the settings than can be passed to the refinementList, see available values here
A short example would be making Facet searchable and limit
function cm_typesense_facet_modifications( $facet_settings, $facet ) {\n if ( $facet == 'category' ) {\n $facet_settings = [\n 'searchable' => true,\n 'limit' => 1\n ];\n }\n\n return $facet_settings;\n}\n\nadd_filter( 'cm_typesense_search_facet_settings', 'cm_typesense_facet_modifications', 10, 2 );\nHere I'm checking that the facet is \"category\" and if it is I am modifying it to make the filter searchable and limit it to 1 result at time.
End Result
"},{"location":"customizing-instant-search-widgets/#sort-by-customization","title":"Sort By Customization","text":"You can only add items to sort by, to allow sorting by various fields. A word of caution this is dependent on your schema so please make sure you are only adding sortable fields here. You should see what are sortable fields in Typesense documentation here
Example to add sort by comment count the following code will work.
function cm_typesense_sortby_items( $items, $post_type ) {\n if ( $post_type == 'post' ) {\n $items[] = [ 'label' => 'Highest Comment Count', 'value' => $post_type . '/sort/comment_count:desc' ];\n }\n\n return $items;\n}\n\nadd_filter( 'cm_typesense_search_sortby_items', 'cm_typesense_sortby_items', 10, 2 );\n End Result
"},{"location":"debug/","title":"Debugging","text":"There are two types of logs: - Error Log - Debug Log
By default, Error Logs are enabled - you can disable them if you want. To do so go to WordPress Dashboard > Typesense > Settings
Dates for logs are all in UTC time for uniformity
"},{"location":"debug/#error-logs","title":"Error Logs:","text":"Error logs are logged if there is an error when a request is made to the Typesense node Some of the examples
Connection to Node cannot be established There was an error when inserting the document to the collection Error creating collection etc. "},{"location":"debug/#debug-log","title":"Debug Log:","text":"Debug log - logs every successful request made to Typesense. You can see the details of what is being sent to the node Another use for debug log would be when bulk indexing documents - if for some reason an error log is not generated and documents aren't being added to collection. You should turn on debug log - and view the log files - this is helpful to see when 1. For some reason a single post is not indexed - while bulk indexing 2. Bulk indexing does not index all posts / post_types.
"},{"location":"debug/#site-info","title":"Site Info:","text":"Site Info - Get info about your WordPress site with the schema info and your Typesense cloud server info
"},{"location":"debug/#curl-error-6-could-not-resolve-host","title":"cURL error 6: Could not resolve host","text":"This means your node could not be resolved.
To resolve this, verify the following:
Check if your credentials are right from the Typesense cloud keys and node. Your instance in Typesense cloud could have expired. Contact Typesense support for that. "},{"location":"getting-started/","title":"Getting Started","text":""},{"location":"getting-started/#generate-api-keys","title":"Generate API Keys","text":"Before you do anything else, you must first add the API keys and configure the node.
If you are hosting Typesense locally / on your own server. Then please see the steps here to generate API Keys https://typesense.org/docs/0.22.1/api/api-keys.html
Otherwise, if you have gone with Typesense cloud option - then once the cluster is set up. There will be an option to generate your API keys.
Above Shows overview of API Keys
Clicking \"Generate API Keys\" - will generate and download API Keys to be used. Keep this file safe and secure for future use.
The Text file will have the following information
Protocol: [https] Port: [443] Admin API Key Search Only API Key Node "},{"location":"getting-started/#configuring-plugin","title":"Configuring Plugin","text":""},{"location":"getting-started/#saving-settings","title":"Saving Settings","text":"After retrieving the required info go to WordPress > Admin Area > Typesense > Settings You will be guided to a page like so.
Here - enter the details provided in the text file and click save. Your WordPress install will now be able to connect to your typensese instance.
"},{"location":"getting-started/#setup-autocomplete-and-indexing","title":"Setup Autocomplete and Indexing","text":"The next step is to enable and start indexing your posts.
Going to Admin Area > Typesense
Here you can
Enable which post types should be indexed Bulk index the selected post types Replace WordPress Search to show autocomplete or instant search popup "},{"location":"getting-started/#enable-post-types","title":"Enable Post Types","text":"This option allows you to select which post types to index. By default the plugin allows you to index posts and pages.
"},{"location":"getting-started/#bulk-index","title":"Bulk Index","text":"Bulk Index option allows you to index all posts(post types) at once. Indexing means they will add the document into Typesense instant to be easily retrieved.
"},{"location":"getting-started/#replace-wordpress-search","title":"Replace WordPress Search","text":"When this option is enabled it will replace all search forms that use default WordPress search with either Instant Search popup or autocomplete. Developer Note: It will replace all calls for get_search_form() and the default WordPress search widget or \"core/search\" block used
"},{"location":"getting-started/#instant-search-popup","title":"Instant Search Popup","text":"Instant Search - replaces all instance of default WordPress search - search forms etc with a popup of instant search. You can customize the appearance of the search by going to appearance > customize > Typesense Search
To add a custom trigger - you can add the class \"cm-swt-instant-search-popup--trigger\" to your button / svg / anchor tag to trigger the popup Something like the following:
<a href=\"#\" class=\"cm-swt-instant-search-popup--trigger cm-swt-instant-search-popup--trigger-default\"><svg xmlns=\"http://www.w3.org/2000/svg\" class=\"h-6 w-6\" fill=\"none\" viewBox=\"0 0 24 24\" stroke=\"currentColor\" stroke-width=\"2\">\n <path stroke-linecap=\"round\" stroke-linejoin=\"round\" d=\"M21 21l-6-6m2-5a7 7 0 11-14 0 7 7 0 0114 0z\" />\n</svg></a>\nReplaces all search forms with Autocomplete. See example here https://typesense.codemanas.com/autocomplete/
"},{"location":"shortcode/","title":"Shortcodes","text":""},{"location":"shortcode/#instant-search","title":"Instant Search","text":""},{"location":"shortcode/#shortcode","title":"Shortcode","text":"[cm_typesense_search post_types=\"book,post\" columns=\"3\" filter=\"show\" per_page=\"3\" sortby=\"off\" placeholder=\"Search for...\" selected_filters=\"show\" stats=\"show\" routing=\"enable\"]\n Values: Any String Description: Determines the placeholder for search field Default: \"Search for\" "},{"location":"shortcode/#columns","title":"columns","text":" Values: 1 to 5 Description: Determines how may results to show per row Default: 3 "},{"location":"shortcode/#post_types","title":"post_types","text":" Values: Post Slugs e.g. post,page,book Description: accepts enabled post_type slugs to show in instant search, accepts multiple slugs in comma separated form post,page,slug If multiple sources are enabled - filtering is disabled. Default: All enabled post_types "},{"location":"shortcode/#filter","title":"filter","text":" Values: show or hide Description: accepts \"show\" or \"hide\" - determines if facet/category filtering should be shown. Default: hide "},{"location":"shortcode/#per_page","title":"per_page","text":" Description: Determines no of possible/matched results to show per_page Default: 3 "},{"location":"shortcode/#sortby","title":"sortby","text":" Values: show or hide Description: Determines whether to provide a sorting option - by default sorting option is according to post published Default: show "},{"location":"shortcode/#pagination","title":"pagination","text":" Values: show or infinite or hide Description: Determines whether to show or hide the pagination for results, select infinite for load more implementation Default: show "},{"location":"shortcode/#query_by","title":"query_by","text":" Values: string (Advanced Usage the typesense documentation) Description: Query results by these fields Default: post_title,post_content "},{"location":"shortcode/#sticky_first","title":"sticky_first","text":" Values: yes or no Description: Show sticky posts first ? Default: no "},{"location":"shortcode/#custom_class","title":"custom_class","text":" Values: comma separated string of html class my-custom-class-1,my-custom-class-2 Description: Ability to add custom class Default: empty "},{"location":"shortcode/#selected_filters","title":"selected_filters","text":" Values: show or hide Description: Shows the selected filters Default: show "},{"location":"shortcode/#stats","title":"stats","text":" Values: show or hide Description: Shows or hide the number of search results retrieved Default: show "},{"location":"shortcode/#routing","title":"routing","text":" Values: enable or disable Description: Enable or Disable routing feature - this adds the selected search query / facets / filters of the current searches being made to the browser URL. Allowing users to share the current search state. Default: disable "},{"location":"shortcode/#autocomplete","title":"Autocomplete","text":""},{"location":"shortcode/#shortcode_1","title":"Shortcode","text":"[cm_typesense_autocomplete placeholder=\"Search for...\"\"]\nDescription: Add the Autocomplete form wherever you may want to. There are no other options.
"},{"location":"shortcode/#options_1","title":"Options:","text":""},{"location":"shortcode/#placeholder_1","title":"placeholder","text":" Values: Any String Description: Determines the placeholder for search field Default: \"Search for\" "},{"location":"shortcode/#query_by_1","title":"query_by","text":" Values: Any String Description: Determines the search query Default: post_title,post_content "},{"location":"template-overriding/","title":"Overriding Template","text":"Overriding the template allows you to change things of the output for your autocomplete or instant search design as you need to.
Plugin base folder: search-with-typesense/templates The templates are in the plugin search-with-typesense/templates and you can override it by copying it to your child theme.
To override, copy files from wp-content/plugins/search-with-typesense/templates/ folder to wp-content/themes/your-theme/search-with-typesense/,
Then you can make the changes as you need. Copy the file main-panel.php from wp-content/plugins/search-with-typesense/templates/instant-search/main-panel.php to wp-content/themes/your-theme/search-with-typesense/instant-search/main-panel.php.
"},{"location":"tsfwc/","title":"Introduction","text":"Typsense Search for WooCommerce is a premimum addon that provides robust, fast search functionality for WooCommerce products on your website.
"},{"location":"tsfwc/#features","title":"Features","text":" Lightning-fast products search results in miliseconds Allow to override WooCommerce product search Allow to hijack WooCommerce shop and archive pages Provides result in WooCommerce default HTML structure Provides all the features for search and filter provided by WooCommerce but in a better and fast way Provides shortcodes for adding search in only specific locations. Hooks and filters for customizations Template Override for design customizations. "},{"location":"tsfwc/#minimum-requirements","title":"Minimum Requirements","text":" PHP 7.4 required or greater MySQL 5.6 or greater is recommended Search with Typsense WooCommerce "},{"location":"tsfwc/#installation","title":"Installation","text":" After purchasing from Codemanas, download the zip file Then on your site's dashboard, go to WordPress Plugins > Add New > Search for \"Search with Typesense\" Click Install and then activate Plugin "},{"location":"tsfwc/#getting-started","title":"Getting started","text":""},{"location":"tsfwc/#activate-license","title":"Activate License","text":"After activating the plugin, go to Typesense->Addons, then activate the license.
"},{"location":"tsfwc/#indexing-products","title":"Indexing products","text":"First you need to index i.e. push data to Typsense cloud. To do so, follow the below steps:
Go to Typsense->Typesense Select the Products post type from the dropdown in Select Posts Types to Enable Then you can set the Products' label and max suggetion to be listed on autocomplete. After that, click the Index button to index. It may take few minutes depending upon the number of products you have. When the indexing is complete, you will get the success message and process is complete.
"},{"location":"tsfwc/#settings","title":"Settings","text":"The plugin provides the following default settings at Typesense->WooCommerce:
Hijack Shop page - Hijack shop page listing by the instant search
Filters
Enable category - Enable category filtering Enable price - Enable price filtering Enable rating - Enable filtering by rating Enable attributes - Enable filter by attributes Enable sortby - Enable sortby Pagination - Enable pagination
Routing - Enabling this option will activate routing, allowing you to share the URL with the applied filter.
Show featured products first - Display featured products first while filtering or searching products
Search placeholder - Change placeholder text on the shop's search
Hijack Product Search - Hijack WooCommerce search widget and block with Autocomplete.
Note: Same settings are provided in Dashboard->Customize then WooCommerce->Typesense Settings for previewing the live changes.
"},{"location":"tsfwc/#shortcodes","title":"Shortcodes","text":""},{"location":"tsfwc/#instant-search","title":"Instant search","text":"Displays the instant search with products.
[cm_tsfwc_search cat_filter='show' price_filter='show' rating_filter='show' attribute_filter='show' pagination='show' sortby='show' placeholder='Search products...' show_featured_first='no']
"},{"location":"tsfwc/#options","title":"Options:","text":"cat_filter
Value: show or hide Description: Determines the showing or hiding of the category filter Default value: \"show\" price_filter
Value: show or hide Description: Determines the showing or hiding of the price filter Default value: \"show\" rating_filter
Value: show or hide Description: Determines the showing or hiding of the rating filter Default value: \"show\" attribute_filter
Value: show or hide Description: Determines the showing or hiding of the attribute filter Default value: \"show\" pagination
Value: show or hide Description: Determines the showing or hiding of pagination Default value: \"show\" routing
Value: enalbe or disable Description: Enabling this will activate routing, allowing you to share the URL with the applied filter. Default value: \"disable\" sortby
Value: show or hide Description: Determines the showing or hiding of the sortby filter Default value: \"show\" placeholder
Value: Any string Description: Placeholder text for the search input field Default value: \"Search products\" show_featured_first
Value: yes or no Description: Show the featured products first on the listing while searching or filtering Default value: \"no\" query_by
Values: string (Advanced Usage the typesense documentation) Description: Query results by these fields Default: post_title,post_content "},{"location":"tsfwc/#autocomplete-search","title":"Autocomplete search","text":"Displays the autocomplete form to search products.
[cm_tsfwc_autocomplete_search placeholder=\"Search products\"]
"},{"location":"tsfwc/#options_1","title":"Options:","text":"placeholder
Value: string Description: Placeholder text for the search form Default value: empty "},{"location":"tsfwc/#template-overwriting","title":"Template Overwriting","text":"Overriding the template allows you to change the output for the product listing design as you need to.
The templates are in the plugin typesense-search-for-woocommerce/templates and you can override it by copying it to your theme.
To override, copy files from wp-content/plugins/typesense-search-for-woocommerce/templates/ folder to wp-content/themes/your-theme/search-with-typesense/woocommerce. Then you can make the changes as you need.
For example: if you want the filters to show up on the right instead of the left.
Copy the file instant-search.php from typesense-search-for-woocommerce/templates/instant-search.php to your-theme/search-with-typesense/woocommerce/instant-search.php.
And change the div structure so that filter-panel is after main-panel.
End result:
"},{"location":"tsfwc/#action-hooks-filter-hooks-extending-plugin","title":"Action Hooks & Filter Hooks / Extending Plugin","text":"There are plenty of Hooks and Filters provided by the plugin to allow developers to customize or add additional functionality to the plugin
"},{"location":"tsfwc/#filter-hooks","title":"Filter Hooks:","text":"Please see https://developer.wordpress.org/plugins/hooks/filters/ for details of what filters are in WordPress.
cm_tsfwc_per_page_config
Description: Change the per page listing and values Arguments: $per_page_config Array of configs with label and value Default value: [\n [ 'label' => 'Per page', 'value' => $atts['per_page'], 'default' => true ],\n [ 'label' => '10 per page', 'value' => 10 ],\n [ 'label' => '20 per page', 'value' => 20 ],\n [ 'label' => '30 per page', 'value' => 30 ],\n [ 'label' => '40 per page', 'value' => 40 ],\n [ 'label' => '50 per page', 'value' => 50 ],\n ]\ncm_tsfwc_product_fields
Description: Add new fields to schema to be indexed. Arguments: $product_fields Array of fields to be indexed. cm_tsfwc_data_before_entry
Description: Add the formatted data to the added fields. Arguments: $formatted_data Array of data to be returned.$raw_data Raw data containing product object $object_id Object ID passed$schema_name Name of the schema which is product in this case. "},{"location":"tsfwc/#action-hooks","title":"Action Hooks:","text":"Please see https://developer.wordpress.org/plugins/hooks/actions/ for details of what action hooks are in WordPress.
cm_tsfwc_custom_attributes
Description: Hook to add custom attributes HTML to the structure Location: templates/instant-search.php "},{"location":"tsfwc/#change-per-page-dropdown-values-on-frontend","title":"Change per page dropdown values on frontend","text":""},{"location":"tsfwc/#use-case","title":"Use Case:","text":"What if you want to change the 10 per page, 20 per page and so on value to your own custom, let's say 50 per page, 100 per page and so on.
"},{"location":"tsfwc/#how-to-do-it","title":"How to do it:","text":"The plugin provides a filter: cm_tsfwc_per_page_config to change it.
You can use it like below:
add_filter( 'cm_tsfwc_per_page_config', 'your_slug_change_per_page' );\n\nfunction your_slug_change_per_page( $per_page_config ) {\n $per_page_config = [\n [ 'label' => '50 per page', 'value' => 50, 'default' => true ], // one value should always have 'default' => true\n [ 'label' => '100 per page', 'value' => 100 ],\n [ 'label' => '150 per page', 'value' => 150 ],\n [ 'label' => '200 per page', 'value' => 200 ],\n ];\n return $per_page_config;\n}\nSuppose you want to add tags ( or any other custom taxonomy ) filter to the shop/archive page other than the default ones provided by the addon.
"},{"location":"tsfwc/#how-to-do-it_1","title":"How to do it:","text":""},{"location":"tsfwc/#format-the-document-data-to-be-indexed-as-facet","title":"Format the document data to be indexed as Facet","text":"To add a new Facet you need to add it as .*_attribute_filter, so if you want to add product_tags you can add it as product_tags_attribute_filter
add_filter( 'cm_tsfwc_data_before_entry', 'your_slug_add_data_before_entry', 10, 4 );\n\nfunction your_slug_add_data_before_entry( $formatted_data, $raw_data, $object_id, $schema_name ) {\n\n if( $schema_name === 'product' ) { // only add data if the schema is product \n\n $product_tags = get_the_terms( $object_id, 'product_tag' );\n\n $product_tags_arr = [];\n\n if( ! is_wp_error( $product_tags ) ) {\n foreach( $product_tags as $product_tag ) {\n $product_tags_arr[] = $product_tag->name;\n }\n } else {\n $product_tags_arr = []; // Only array can be pushed to the data. When no data, empty array is the must\n }\n\n $formatted_data['product_tags_attribute_filter'] = $product_tags_arr;\n }\n\n return $formatted_data;\n\n}\n\nTo display the filter on the frontend, use the action hook cm_tsfwc_custom_attributes like below:
add_action( 'cm_tsfwc_custom_attributes', 'your_slug_add_custom_attr' );\n\nfunction your_slug_add_custom_attr() {\n echo '<div \n data-attr_facet_name=\"product_tags_attribute_filter\" \n data-title =\"' . __( \"Filter by Tags\", 'storefront' ) . '\" \n class=\"cm-tsfwc-shortcode-tags-attribute-filters\" \n data-filter_type=\"refinementList\"\n data-settings=\"' . _wp_specialchars( json_encode( [ \"searchable\" => false ] ), ENT_QUOTES, \"UTF-8\", true ) . '\"\n ></div>';\n}\n\n data-facet_name: It should same as the name of the field added before. For example: here name of the field added before is 'product_tags_attribute_filter' so the data-facet_name should be product_tags_attribute_filter
data-title: Title for the filter
data-filter_type: Type of filter to use
"},{"location":"tsfwc/#adding-static-code-widgets-to-the-sidebar","title":"Adding static code / widgets to the sidebar","text":""},{"location":"tsfwc/#use-case_2","title":"Use Case:","text":"Suppose you want to add default WooCommerce widgets like Top Rated Products below the filters
"},{"location":"tsfwc/#how-to-do-it_2","title":"How to do it:","text":""},{"location":"tsfwc/#use-cm_tsfwc_filter_panel_output-hook","title":"Use cm_tsfwc_filter_panel_output hook","text":"add_action( 'cm_tsfwc_filter_panel_output', 'mytheme_add_widgets',40 );\n\nfunction mytheme_add_widgets() {\n the_widget( 'WC_Widget_Top_Rated_Products' );\n}\n\nSuppose you want to remove Filter by size filter.
"},{"location":"tsfwc/#use-cm_tsfwc_attribute_facet_skip-hook","title":"Use cm_tsfwc_attribute_facet_skip hook","text":"add_filter( 'cm_tsfwc_attribute_facet_skip', 'mytheme_hide_attribute_facet' );\n\nfunction mytheme_hide_attribute_facet() {\n return ['book-author'];\n}\nfunction your_slug_change_cat_filter_type( $filterType ) {\n\n $filterType = 'menu';\n\n return $filterType;\n}\n\nadd_filter( 'cm_tsfwc_category_filter_type', 'your_slug_change_cat_filter_type' );\n** Acceptable filter type = refinementList, menu **
"},{"location":"tsfwc/#changing-type-of-widget-in-price-filter","title":"Changing type of widget in Price filter","text":"function your_slug_change_price_filter_type( $filterType ) {\n\n $filterType = 'rangeSlider';\n\n return $filterType;\n}\n\nadd_filter( 'cm_tsfwc_price_filter_type', 'your_slug_change_price_filter_type' );\n** Acceptable filter type = rangeSlider, rangeInput **
"},{"location":"tsfwc/#changing-type-of-widget-in-rating-filter","title":"Changing type of widget in Rating filter","text":"function your_slug_change_rating_filter_type( $filterType ) {\n\n $filterType = 'rangeSlider';\n\n return $filterType;\n}\n\nadd_filter( 'cm_tsfwc_rating_filter_type', 'your_slug_change_rating_filter_type' );\n** Acceptable filter type = ratingMenu, rangeSlider, rangeInput **
"},{"location":"tsfwc/#changing-type-of-widget-in-attribute-filters","title":"Changing type of widget in Attribute filters","text":"function your_slug_change_attribute_filter_type( $filterType, $attributeName ) {\n\n if ( $attributeName == 'size' ) {\n $filterType = 'menu';\n }\n\n return $filterType;\n}\n\nadd_filter( 'cm_tsfwc_attribute_filter_type', 'your_slug_change_attribute_filter_type', 10, 2 );\n** Acceptable filter type = refinementList, menu rangeInput, rangeSlider **
Note: For rangeSlider and rangeInput the schema for field must be int64
"},{"location":"tsfwc/#addingchanging-facets-settings","title":"Adding/changing facets settings","text":""},{"location":"tsfwc/#changing-facet-settings-in-category-filter","title":"Changing facet settings in Category filter","text":"function your_slug_change_facet_setting( $filterSettings ) {\n\n $filterSettings = [ 'searchable' => true ];\n\n return $filterSettings;\n}\n\nadd_filter( 'cm_tsfwc_category_facet_settings', 'your_slug_change_facet_setting' );\nSee here for available options.
Note: container and attribute are not overridable
"},{"location":"tsfwc/#changing-facet-settings-in-price-filter","title":"Changing facet settings in Price filter","text":"function your_slug_change_facet_setting( $filterSettings ) {\n\n $filterSettings = [ 'pips' => false ];\n\n return $filterSettings;\n}\n\nadd_filter( 'cm_tsfwc_price_facet_settings', 'your_slug_change_facet_setting' );\nSee here for available options.
Note: container and attribute are not overridable
"},{"location":"tsfwc/#changing-facet-settings-in-rating-filter","title":"Changing facet settings in Rating filter","text":"function your_slug_change_facet_setting( $filterSettings ) {\n\n $filterSettings = [ 'max' => 5 ];\n\n return $filterSettings;\n}\n\nadd_filter( 'cm_tsfwc_rating_facet_settings', 'your_slug_change_facet_setting' );\nSee here for available options.
"},{"location":"tsfwc/#changing-facet-settings-in-custom-attribute-filter","title":"Changing facet settings in Custom Attribute filter","text":"function your_slug_change_facet_setting( $filterSettings, $attrName ) {\n\n if( 'color' == $attrName ) {\n $filterSettings = [ 'searchable' => true ];\n }\n\n return $filterSettings;\n}\n\nadd_filter( 'cm_tsfwc_attribute_facet_settings', 'your_slug_change_facet_setting', 10, 2 );\nSee here for available options.
Note: container and attribute are not overridable
"},{"location":"tsfwc/#wpml-integration","title":"WPML Integration","text":"As of version 1.2.4 of Typesense search for WooCommerce - the plugin is compatible with WPML and adds features to integrate with WPML + WooCommerce The plugins required for WPML Integration are :
"},{"location":"tsfwc/#pre-requisites","title":"Pre-requisites","text":" WooCommerce Multilingual WPML 4.4.11 or aboves WPML String Translation WPML Translation Management (not needed for WooCommerce 3.9.0) Typesense Search for WooCommerce If you want to use different media (images) for different translations of a product, you need to install WPML Media.
"},{"location":"tsfwc/#wpml-translation-modes-and-tools","title":"WPML Translation modes and tools","text":"There are two different translation modes while using WPML. Please see WPML documentation for detailed information.
Translate Everything : All of the site\u2019s main content will be automatically translated into all secondary languages as content is published or updated. Translations can then be reviewed on the front-end and edited by the user (or local translator) if needed. Translate Some : Users can pick and choose what to translate, when to translate it, and who will translate it. This mode allows for content to be translated manually, translated via WPML\u2019s Advanced Translation Editor, translated by professional translation services , or even translated by a team of local translators. "},{"location":"tsfwc/#translating-content","title":"Translating Content:","text":"For translation of content - there is nothing new you need to do on the typesense plugin. Based on your setup the WooCommerce Products, Pages (checkout, cart, my-account etc), translations are handled by the WooCommerce Multilingual plugin - please see translating products
What is required for Typesense integration is only on initial installation. You would need to index your products for each language you have.
"},{"location":"tsfwc/#indexing-products_1","title":"Indexing Products:","text":"To index products you will need to go to WP Admin > Typesense Here you will be shown the Typesense Search Config settings and you can index the products. The only difference here is to switch language on your admin screen for each of your language to index your products. This step - is a one time step - meaning it only needs to be done once - when the plugin is initially configured. Please see video for a small walk through.
Once the indexing is complete, all your current products will show up in the shop and users will be show the products based on the current language the user has selected. For new products - they will be indexed to the correct translation - when they are added / updated. And will be removed if they are deleted / status visibility of product is changed.
"},{"location":"tsfwc/#translating-plugin-strings","title":"Translating Plugin Strings","text":"Some strings are hardcoded into the plugin and will require string translation. You can see detailed documentation for string translation here. Please see this short video on how to translate strings.
Note: container and attribute are not overridable
"},{"location":"tsfwc/#making-category-menu-filter-a-hierarchical-menu","title":"Making category menu filter a hierarchical menu","text":"Hierarchical menu is a navigaton based on a hierarchy of attributes like category and it's subcategories. See below for example:
From version 1.3.5, we have added an option to change the defalut category menu filter to hierarchical menu. Follow the below steps:
Go to Dashboard -> Typesense -> WooCommerce In Advance Settings, enable the Make the default Category filter hierarchical menu Click Save Changes button After saving, you need to Delete and Re-index your Products from Typesense->Typesense in Search Configuration tab. Please note that enabling this option will be resource heavy and may make your backend slow.
This is because WooCommerce does not provide the default hierarchy of the products' categories and subcategories. So we have to manually query all the categoires and make a hierarchy which in itself is a heavy process. Further more, on adding, updating and deleting of a category, we have to repeat the proess and index again.
"},{"location":"tsfwc/#additional-search-parameters-for-default-search-configuration","title":"Additional search parameters for default search configuration","text":"From version 1.3.7, you can configure additional search parameters for both Instant search and Autocomplete using the filter hooks mentioned below:
cm_tsfwc_additional_search_params - Configure instant search additional search parameters
cm_tsfwc_additional_autocomplete_params - Configure autocomplete search additional search parameters
Example code:
add_filter( 'cm_tsfwc_additional_search_params', 'theme_slug_alter_search_params' );\nfunction theme_slug_alter_search_params() {\n return [\n 'hidden_hits' => 3662,\n // 'query_by_weights' => '1,2', \n // 'query_by' => \"post_content,post_title\",\n // 'sort_by' => 'total_sales:asc', // work only with numerical fields\n // 'filter_by' => 'post_title: test',\n // 'facet_by' => 'category,prices', // can not override so dont work\n // 'max_facet_values' => 1, // can not override so don't work\n // 'facet_query' => 'category_lvl0: Alaram',\n // 'num_typos' => 2,\n // 'page' => 2, // cannot override so don't work\n // 'group_by' => 'category',\n // 'highlightFullFields' => 'post_title,post_content,test',\n // 'include_fields' => 'price,prices',\n // 'pinned_hits' => '3662:2',\n ];\n}\nYou can refer here: https://typesense.org/docs/0.23.1/api/search.html#search-parameters for additional parameters.
Note: Some parameters like facet_by, q, max_facet_values, page can not be overwritten. Others can be passed as required.
"},{"location":"tsfwc/#search-only-after-certain-character-length","title":"Search only after certain character length","text":"From version 1.4.8, you can configure search to be triggered after certain characters are typed on search bar. The new filter introduced is cm_tsfwc_search_query_length
You can use the hook like below. The below code triggers search only when 4 character is typed on search bar:
add_filter( 'cm_tsfwc_search_query_length', 'your_slug_serach_after_char_count' ); \n\nfunction your_slug_serach_after_char_count( $count ) {\n $count = 4;\n return $count;\n}\n\nBy default, the schema of page gets the same schema as post. That means page will also have category and cat_links in it's schema. But that is redundent since page does not have categories. So those fields should be removed from page's schema.
To remove the fields, paste the below code in your theme's functions.php
add_filter( 'cm_typesense_schema', 'remove_cat_facet_from_page', 10, 2 );\n\n function remove_cat_facet_from_page( $schema, $name ) {\n if ( $name == 'page' ) {\n foreach( $schema['fields'] as $index => $field ) {\n if( 'category' == $field['name'] || 'cat_link' == $field['name'] ) {\n unset( $schema['fields'][ $index ]);\n } \n }\n }\n\n // Should be sorted because unset removes the index number only and leave empty in between\n sort( $schema['fields']);\n return $schema;\n}\nNote: After implementing this, page has to be reindexed by clicking Delete and Re-index on settings page
"},{"location":"wp-cli/","title":"WP CLI","text":""},{"location":"wp-cli/#wp-cli","title":"WP CLI","text":"WP-CLI serves as the command-line interface for WordPress, offering a range of commands for various actions typically executed in the WordPress admin.
Within the framework of the Search With Typesense plugin, our plugin introduces its own set of WP-CLI commands. These commands enable you to index and delete post types, with the flexibility to specify particular IDs. Additionally, the plugin provides an option to assess the health status of the Typesense server.
This is very helpful if you have command line access to your WordPress installation instace on your server.
Kindly be aware that the subsequent commands will not remove your posts from the WordPress database. Instead, these commands exclusively index or delete the posts on your Typesense Server.
Note: We intend to incorporate additional commands in the future based on your requests. Your feedback would be highly valuable.
"},{"location":"wp-cli/#supported-commands","title":"Supported Commands","text":""},{"location":"wp-cli/#wp-typesense-index","title":"wp typesense index","text":"Index a specific post type to Typesense server
"},{"location":"wp-cli/#options","title":"Options","text":" Slug of the post type you want to index.
[--ids=]
The comma separated IDs of the posts of that post type you want to index.
"},{"location":"wp-cli/#examples","title":"Examples","text":"# Index all the default posts\n$ wp typesense index post\n# Index all only specific posts with IDs: 2,3 and 4 for the custom post type 'books'\n$ wp typesense index books --ids=2,3,4\nDelete a specific post type from Typesense server
"},{"location":"wp-cli/#options_1","title":"Options","text":"
Slug of the post type you want to delete.
[--ids=]
The comma separated IDs of the posts of that post type you want to delete.
"},{"location":"wp-cli/#examples_1","title":"Examples","text":"# delete all the default posts\n$ wp typesense delete post\n# delete all only specific posts with IDs: 2,3 and 4 for the custom post type 'books'\n$ wp typesense delete books --ids=2,3,4\nCheck the health status of your Typesense server.
"},{"location":"wp-cli/#examples_2","title":"Examples","text":"$ wp typesense health\nDisplaying the filter
function your_slug_add_custom_attr() {
echo '<div
- data-facet_name="product_tags_attribute_filter"
+ data-attr_facet_name="product_tags_attribute_filter"
data-title ="' . __( "Filter by Tags", 'storefront' ) . '"
class="cm-tsfwc-shortcode-tags-attribute-filters"
data-filter_type="refinementList"
diff --git a/unset-cat-from-page/index.html b/unset-cat-from-page/index.html
old mode 100644
new mode 100755
index 4dc1124..0854985
--- a/unset-cat-from-page/index.html
+++ b/unset-cat-from-page/index.html
@@ -18,7 +18,7 @@