FiboSearch

https://fibosearch.com/documentation/
Admin
FiboSearch is a WooCommerce search plugin featuring fuzzy search, intelligent product indexing,...
Tokens:59,052
Snippets:837
Trust Score:9.1
Update:6 months ago
Show doc for...
Tokens:
Raw
### Example 5: Promoting popular products by total sales

Source: https://fibosearch.com/documentation/tips-tricks/how-to-change-the-order-of-search-results

This example promotes products based on their total sales count. Apply this as a normal WordPress snippet.

```php
add_filter( 'fibosearch_get_score_args', function( $args ) {
    $product = wc_get_product( $args['product_id'] );
    if ( $product && $product->get_total_sales() ) {
        $args['score'] = $args['score'] + $product->get_total_sales();
    }
    return $args;
} );
```

--------------------------------

### Complex FiboSearch Shortcode Examples

Source: https://fibosearch.com/documentation/get-started/using-a-fibosearch-shortcode

Combine multiple parameters for specific layouts. These examples serve as a starting point for custom FiboSearch configurations.

```shortcode
[fibosearch style="solaris" mobile_overlay="1"]
```

```shortcode
[fibosearch style="pirx" layout="search-bar" mobile_overlay="0"]
```

--------------------------------

### Example 3: Promoting products in a specific category

Source: https://fibosearch.com/documentation/tips-tricks/how-to-change-the-order-of-search-results

This example demonstrates how to promote products that belong to a specific category. Apply this as a normal WordPress snippet.

```php
add_filter( 'fibosearch_get_score_args', function( $args ) {
    if ( has_term( 'your-category-slug', 'product_cat', $args['product_id'] ) ) {
        $args['score'] = $args['score'] + 200;
    }
    return $args;
} );
```

--------------------------------

### Example 1: Demoting "out of stock" products

Source: https://fibosearch.com/documentation/tips-tricks/how-to-change-the-order-of-search-results

This snippet demonstrates how to demote products that are out of stock. Apply this as a normal WordPress snippet.

```php
add_filter( 'fibosearch_get_score_args', function( $args ) {
    if ( ! empty( $args['product_id'] ) && ! wc_get_product( $args['product_id'] )->is_in_stock() ) {
        $args['score'] = $args['score'] - 1000;
    }
    return $args;
} );
```

--------------------------------

### Configuring Search Results Shortcode Parameters

Source: https://fibosearch.com/documentation/features/displaying-more-than-just-products-on-the-woocommerce-search-results-page

Examples of using shortcode parameters to control layout, result limits, and image visibility.

```text
[fibosearch_posts_results post_type="post" layout="grid"]
```

```text
[fibosearch_posts_results post_type="post" layout="list"]
```

```text
[fibosearch_posts_results post_type="testimonial" layout=grid show_image]
```

--------------------------------

### Display Product Attribute in Search Results (PHP)

Source: https://fibosearch.com/documentation/tips-tricks/how-to-display-extra-text-in-search-suggestions

This example outlines the process for displaying product attributes, like 'case pack size', in search results. It refers to Example 1 for detailed steps, requiring the replacement of 'book_author' with the specific taxonomy name (e.g., 'pa_case-pack-size').

--------------------------------

### WooCommerce Search URL Example

Source: https://fibosearch.com/documentation/features/displaying-more-than-just-products-on-the-woocommerce-search-results-page

This is an example of a WooCommerce search results page URL when using FiboSearch, indicating that WooCommerce is loading an Archive Products template.

```url
https://yoursite.com/?s=keyword&post_type=product&dgwt_wcas=1
```

--------------------------------

### Create fibosearch.php file

Source: https://fibosearch.com/documentation/tips-tricks/how-to-add-custom-code-to-your-website

Create a `fibosearch.php` file in the root directory of your child theme or the `wp-content` directory if not using a child theme. Ensure the file starts with the opening PHP tag.

```php
<?php
// Add custom code for FiboSearch features here
?>
```

--------------------------------

### Example 2: Increasing weight for specific custom field

Source: https://fibosearch.com/documentation/tips-tricks/how-to-change-the-order-of-search-results

This snippet shows how to increase the weight of products that have a specific value in a custom field. This snippet requires SHORTINIT mode.

```php
add_filter( 'fibosearch_get_score_args', function( $args ) {
    $product = wc_get_product( $args['product_id'] );
    if ( $product && $product->get_meta( '_my_custom_field' ) === 'promote_me' ) {
        $args['score'] = $args['score'] + 500;
    }
    return $args;
} );
```

--------------------------------

### Example 4: Including menu_order in search results order

Source: https://fibosearch.com/documentation/tips-tricks/how-to-change-the-order-of-search-results

This snippet shows how to include the 'menu_order' post field in the search results ordering. This snippet requires SHORTINIT mode.

```php
add_filter( 'fibosearch_get_score_args', function( $args ) {
    $product = wc_get_product( $args['product_id'] );
    if ( $product ) {
        $args['score'] = $args['score'] + $product->get_menu_order();
    }
    return $args;
} );
```

--------------------------------

### Configure NGINX for Multisite

Source: https://fibosearch.com/documentation/troubleshooting/the-search-endpoint-url-is-blocked

Add these rewrite rules to the NGINX configuration to ensure correct search results in multisite directory-based installations.

```nginx
if (!-e $request_filename) {
rewrite ^(/[^/]+)?(/search\.php) /$2 last;
}
```

```nginx
if (!-e $request_filename) { rewrite ^(/[^/]+)?(/search\.php) /$2 last; }
```

```nginx
if (!-e $request_filename) {
  rewrite ^(/[^/]+)?(/search\.php) /$2 last;
}
```

--------------------------------

### Enable Searching in Custom Post Types

Source: https://fibosearch.com/documentation/features/displaying-more-than-just-products-on-the-woocommerce-search-results-page

To enable searching in custom post types, refer to the provided guide for specific instructions.

```php
Searching for custom post types.
```

--------------------------------

### Add FiboSearch with Layout Parameter

Source: https://fibosearch.com/documentation/get-started/how-to-add-fibosearch-to-your-website

Customize the FiboSearch appearance in PHP files by passing parameters to the `[fibosearch]` shortcode. The `layout="icon"` parameter is an example of how to change the search bar's display.

```php
<?php echo do_shortcode('[fibosearch layout="icon"]'); ?>
```

--------------------------------

### Enable variation search by exact GUID

Source: https://fibosearch.com/documentation/features/searching-by-gtin-upc-ean-or-isbn

Use this filter to enable searching for product variations by their exact global unique identifier. Rebuild the index in the FiboSearch settings after adding this code.

```php
add_filter( 'dgwt/wcas/variation_support_modes', function() {
return ['search_in_sku', 'search_in_global_unique_id', 'exact_match'];
} );
```

```php
add_filter( 'dgwt/wcas/variation_support_modes', function() { return ['search_in_sku', 'search_in_global_unique_id', 'exact_match']; } );
```

```php
add_filter( 'dgwt/wcas/variation_support_modes', function() {
    return ['search_in_sku', 'search_in_global_unique_id', 'exact_match'];
} );
```

--------------------------------

### Enable TablePress Shortcode Indexing in FiboSearch

Source: https://fibosearch.com/documentation/tips-tricks/expand-shortcodes-when-indexing

Use this PHP snippet to allow FiboSearch to index content within [table] shortcodes. Ensure TablePress is installed and activated. Rebuild the FiboSearch index after adding this code.

```php
// Allow [table] shortcode indexing
add_filter( 'dgwt/wcas/indexer/allowed_shortcodes', function ( $shortcodes ) {
    $shortcodes[] = 'table';
    return $shortcodes;
} );

// Init TablePress shortcodes
function fibosearch_init_tablepress_shortcodes() {
    if ( defined( 'TABLEPRESS_ABSPATH' ) ) {
        if ( ! isset( TablePress::$model_options ) ) {
            include_once TABLEPRESS_ABSPATH . 'classes/class-model.php';
            include_once TABLEPRESS_ABSPATH . 'models/model-options.php';
            TablePress::$model_options = new TablePress_Options_Model();
        }
        $tablepress_controller = TablePress::load_controller( 'frontend' );
        $tablepress_controller->init_shortcodes();
    }
}

// Init TablePress before batch indexing
add_action( 'dgwt/wcas/searchable_index/bg_processing/before_task', function () {
    fibosearch_init_tablepress_shortcodes();
} );

// Init TablePress while single product update
add_action( 'dgwt/wcas/tnt/background_product_update', function ( $action, $postID ) {
    if ( $action !== 'update' ) {
        return;
    }
    fibosearch_init_tablepress_shortcodes();
}, 5, 2 );

```

--------------------------------

### Enable WordPress SHORTINIT mode

Source: https://fibosearch.com/documentation/troubleshooting/the-search-endpoint-url-is-blocked

Define this constant to load WordPress in a minimal state, excluding plugins and themes to improve performance.

```php
define( 'SHORTINIT', true );
```

--------------------------------

### Running SHORTINIT Mode Snippets

Source: https://fibosearch.com/documentation/tips-tricks/how-to-display-extra-text-in-search-suggestions

Snippets marked with '[SHORTINIT MODE]' must be placed in a `fibosearch.php` file in your child theme's root directory. This mode optimizes performance for specific FiboSearch functionalities.

```php
<?php

/**
 * SHORTINIT MODE
 *
 * This snippet demonstrates how to display custom content in search suggestions
 * when FiboSearch is running in SHORTINIT mode. This is typically used for
 * performance-critical operations.
 */

// Example: Displaying a custom field value for products.
add_filter( 'fibosearch_suggestions_product_data', function( $data, $product ) {
    // Replace 'your_custom_field_key' with the actual meta key of your custom field.
    $custom_value = get_post_meta( $product->get_id(), 'your_custom_field_key', true );
    if ( ! empty( $custom_value ) ) {
        $data['custom_field'] = $custom_value;
    }
    return $data;
}, 10, 2 );

// Example: Displaying a custom attribute for products.
add_filter( 'fibosearch_suggestions_product_data', function( $data, $product ) {
    // Replace 'your_attribute_slug' with the actual slug of your product attribute.
    $attribute_value = $product->get_attribute( 'your_attribute_slug' );
    if ( ! empty( $attribute_value ) ) {
        $data['custom_attribute'] = $attribute_value;
    }
    return $data;
}, 10, 2 );

// Example: Displaying terms from a custom taxonomy for products.
add_filter( 'fibosearch_suggestions_product_data', function( $data, $product ) {
    // Replace 'your_taxonomy_slug' with the actual slug of your custom taxonomy.
    $terms = get_the_terms( $product->get_id(), 'your_taxonomy_slug' );
    if ( ! is_wp_error( $terms ) && ! empty( $terms ) ) {
        $term_names = wp_list_pluck( $terms, 'name' );
        $data['custom_taxonomy_terms'] = implode( ', ', $term_names );
    }
    return $data;
}, 10, 2 );

```

--------------------------------

### Exclude Specific Search Phrases

Source: https://fibosearch.com/documentation/features/fibosearch-analytics

Example implementation of the analytics filter to ignore specific search terms.

```php
add_filter( 'dgwt/wcas/analytics/should_record', function ( $shouldRecord, $data ) {
	if ( $data['phrase'] === 'something' ) {
		return false;
	}

	return $shouldRecord;
}, 10, 2 );
```

--------------------------------

### Combine debug parameters

Source: https://fibosearch.com/documentation/troubleshooting/debugging-fibosearch

Demonstrates how to apply multiple debug parameters simultaneously by separating them with a comma.

```text
https://yourdomain.com?fibodebug=nofuzzy,score
```

--------------------------------

### Enable combined word search in FiboSearch

Source: https://fibosearch.com/documentation/features/combined-words-and-special-character-replacement

Enables the indexing of product text without spaces to support combined word queries. Requires a manual index rebuild after implementation.

```php
add_filter( 'dgwt/wcas/indexer/searchable/enable_append_joined_text', '__return_true' );
```

--------------------------------

### Display CPT results on search page

Source: https://fibosearch.com/documentation/features/searching-for-custom-post-types

Inject custom post type results into the WooCommerce search results page using the [fibosearch_posts_results] shortcode. This example hooks into the 'no_products_found' and 'before_shop_loop' actions.

```php
add_action( 'woocommerce_no_products_found', function () {
   if ( ! \DgoraWcas\Helpers::isProductSearchPage() ) {
      return;
   }
   echo do_shortcode( '[fibosearch_posts_results post_type="designer" layout=grid show_image]' );
   echo do_shortcode( '[fibosearch_posts_results post_type="testimonial" layout=grid show_image]' );
} );
add_action( 'woocommerce_before_shop_loop', function () {
   if ( ! \DgoraWcas\Helpers::isProductSearchPage() ) {
      return;
   }
   echo do_shortcode( '[fibosearch_posts_results post_type="designer" layout=grid show_image]' );
   echo do_shortcode( '[fibosearch_posts_results post_type="testimonial" layout=grid show_image]' );
} );
```

--------------------------------

### Set FiboSearch Style via Shortcode

Source: https://fibosearch.com/documentation/get-started/using-a-fibosearch-shortcode

Use the 'style' parameter to choose between 'solaris' (default) and 'pirx' for the search bar appearance. This overrides the global setting.

```html
[fibosearch style="solaris"]
```

--------------------------------

### Exclude Product Attributes from FiboSearch

Source: https://fibosearch.com/documentation/tips-tricks/how-to-exclude-certain-attributes-from-the-search-scope

Use this code to define and exclude specific product attributes from FiboSearch. This is useful for attributes that should not appear in search results or be indexed. Remember to replace the example attribute slugs with your own.

```php
/**
 * Attributes to exclude
 * 
 * @return array
 */
function fibosearch_get_attributes_to_exclude() {
	return array(
		'pa_calipers', //Replace with yours!!!
		'pa_case-size' //Replace with yours!!!
	);
}

/**
 * Exclude attribute every time when the product is updated
 * 
 * @return array
 */
add_filter( 'dgwt/wcas/product/attributes', function ( $attributes ) {
	foreach ( fibosearch_get_attributes_to_exclude() as $taxonomy ) {
		if ( array_key_exists( $taxonomy, $attributes ) ) {
			unset( $attributes[ $taxonomy ] );
		}
	}

	return $attributes;
} );

/**
 * Exclude attribute every time when the whole index process is running
 * 
 * @return array
 */
add_filter( 'dgwt/wcas/attribute_taxonomies', function ( $taxonomies ) {
	foreach ( fibosearch_get_attributes_to_exclude() as $taxonomy ) {
		if ( ( $key = array_search( $taxonomy, $taxonomies ) ) !== false ) {
			unset( $taxonomies[ $key ] );
		}
	}

	return $taxonomies;
} );
```

--------------------------------

### Running Normal WordPress Snippets

Source: https://fibosearch.com/documentation/tips-tricks/how-to-display-extra-text-in-search-suggestions

Apply snippets like this in your child theme's functions.php file or via the Code Snippets plugin. No special initialization is required.

```php
<?php

/**
 * Add custom fields, attributes, or taxonomies to search suggestions.
 *
 * This snippet demonstrates how to hook into FiboSearch to display additional product information.
 * Replace 'your_custom_field_key', 'your_attribute_slug', or 'your_taxonomy_slug' with your actual values.
 */
add_filter( 'fibosearch_suggestions_product_data', function( $data, $product ) {

    // Example 1: Display book authors (custom taxonomy)
    $terms = get_the_terms( $product->get_id(), 'your_taxonomy_slug' );
    if ( ! is_wp_error( $terms ) && ! empty( $terms ) ) {
        $author_names = wp_list_pluck( $terms, 'name' );
        $data['author'] = implode( ', ', $author_names );
    }

    // Example 2: Display EAN code (custom field)
    $ean = get_post_meta( $product->get_id(), 'your_custom_field_key', true );
    if ( ! empty( $ean ) ) {
        $data['ean'] = $ean;
    }

    // Example 3: Display case pack size (product attribute)
    $case_pack = $product->get_attribute( 'your_attribute_slug' );
    if ( ! empty( $case_pack ) ) {
        $data['case_pack'] = $case_pack;
    }

    // Example 4: Display "in stock" or "out of stock" status
    $data['stock_status'] = $product->is_in_stock() ? __( 'In Stock', 'fibosearch' ) : __( 'Out of Stock', 'fibosearch' );

    return $data;

}, 10, 2 );

/**
 * Example 5: Display product category description below categories.
 */
add_filter( 'fibosearch_suggestions_category_data', function( $data, $category ) {
    if ( ! empty( $category->description ) ) {
        $data['category_description'] = $category->description;
    }
    return $data;
}, 10, 2 );

/**
 * Example 6: Display post excerpt below post title.
 */
add_filter( 'fibosearch_suggestions_post_data', function( $data, $post ) {
    if ( ! empty( $post->post_excerpt ) ) {
        $data['post_excerpt'] = $post->post_excerpt;
    }
    return $data;
}, 10, 2 );

```

--------------------------------

### Configure responsive layout breakpoints

Source: https://fibosearch.com/documentation/features/search-bar-layout

Define custom width breakpoints in pixels to control when the search bar switches between icon and bar modes.

```text
[fibosearch layout="flex-icon-on-mobile" layout_breakpoint="800" ]
[fibosearch layout="flex-icon-on-desktop" layout_breakpoint="800" ]
```

--------------------------------

### Integrate FiboSearch into Arrival Store theme

Source: https://fibosearch.com/documentation/themes-integrations/arrival-store-theme

Use this snippet to replace the default search bar with the FiboSearch shortcode and apply custom CSS styling.

```php
/**
* AJAX Search for WooCommerce - integration
*
*/
if(!function_exists ('arrival_store_product_search')){
function arrival_store_product_search(){
echo do_shortcode('[wcas-search-form]');
}
}
add_action('wp_head', function(){
?>
<style>
.product-search {
width: 100%;
}
</style>
<?php
});
```

```php
/** * AJAX Search for WooCommerce - integration * */ if(!function_exists ('arrival_store_product_search')){ function arrival_store_product_search(){ echo do_shortcode('[wcas-search-form]'); } } add_action('wp_head', function(){ ?> <style> .product-search { width: 100%; } </style> <?php });
```

```php
/**
 * AJAX Search for WooCommerce - integration
 *
 */
if(!function_exists ('arrival_store_product_search')){
    function arrival_store_product_search(){
        echo do_shortcode('[wcas-search-form]');
    }
}
add_action('wp_head', function(){
    ?>
    <style>
        .product-search {
            width: 100%;
        }
    </style>
    <?php
});
```

--------------------------------

### Get Client IP Address

Source: https://fibosearch.com/documentation/features/fibosearch-analytics

This function attempts to determine the client's real IP address by checking various server headers. It prioritizes headers that are commonly used to forward client IP information, such as `HTTP_X_FORWARDED_FOR`.

```PHP
/**
* Get the best guess for the client's real IP address.
*
* @return string|false
*/
function dgwt_wcas_get_client_ip() {
$client_ip = false;
$address_headers = array(
'HTTP_CLIENT_IP',
'HTTP_X_FORWARDED_FOR',
'HTTP_X_FORWARDED',
'HTTP_X_CLUSTER_CLIENT_IP',
'HTTP_FORWARDED_FOR',
'HTTP_FORWARDED',
'REMOTE_ADDR',
);

foreach ( $address_headers as $header ) {
if ( array_key_exists( $header, $_SERVER ) ) {
// HTTP_X_FORWARDED_FOR can contain a chain of addresses (e.g., proxies)
$address_chain = explode( ',', $_SERVER[ $header ] );
$client_ip = trim( $address_chain[0] );
break;
}
}

return $client_ip;
}
```

--------------------------------

### Include SKUs and excerpts in combined word search

Source: https://fibosearch.com/documentation/features/combined-words-and-special-character-replacement

Extends the combined word indexing to include SKU and excerpt fields in addition to the default product name. Requires a manual index rebuild after implementation.

```php
add_filter( 'dgwt/wcas/indexer/searchable/append_joined_text/fields', function ( $fields ) {
	return [ 'name', 'sku', 'excerpt' ];
} );
```

--------------------------------

### Replace Conj Search with AJAX Search for WooCommerce

Source: https://fibosearch.com/documentation/themes-integrations/conj-lite-theme

Add this PHP code to your Conj child theme's functions.php file to replace the default search bar with the AJAX search form shortcode. Ensure the 'AJAX Search for WooCommerce' plugin is installed and activated.

```php
/**
 * Replace Conj search with AJAX Serch for WooCommerce
 */
if ( ! function_exists( 'conj_lite_wc_search_field' ) ) {
    function conj_lite_wc_search_field() {
    ?>
        <div class="site-header__search">
            <?php echo do_shortcode( '[wcas-search-form]' ); ?>
        </div>
    <?php
    }
}
```

--------------------------------

### Add Custom Image Size and Filter for Details Panel

Source: https://fibosearch.com/documentation/tips-tricks/how-to-change-image-sizes

Use this PHP code to define a new image size and apply it to product thumbnails in the Details Panel. This requires the 'init' hook for image size registration and a filter for the thumbnail size.

```php
add_action( 'init', function () {
	add_image_size( 'dgwt-wcas-product-custom', 300, '', false );
} );

add_filter( 'dgwt/wcas/suggestion_details/product/thumb_size', function ( $size ) {
	return 'dgwt-wcas-product-custom';
} );
```

--------------------------------

### Always show 'Products' headline (FiboSearch Pro)

Source: https://fibosearch.com/documentation/get-started/customize-search-appearance

Use this PHP snippet to always display the 'Products' headline in search results, even when only products are shown. Designed for use with SHORTINIT mode.

```php
<?php

// [SHORTINIT MODE]

add_filter( 'dgwt/wcas/search_results/always_show_product_headline', '__return_true' );
```

--------------------------------

### Programmatic Indexing with WordPress Hooks

Source: https://fibosearch.com/documentation/developers/indexing

Use these actions to rebuild the entire index or manage specific posts. Ensure these are called after the required hooks and priorities specified in the comments.

```php
// Rebuilding the entire index. Use in later hook than plugins_loaded priority 15
// WARNING: This actions should be called later than plugins_loaded hook with priority 15
do_action( 'dgwt/wcas/indexer/build' );

// Update or delete the indicated posts in the index
// WARNING: These actions should be called later than init hook with priority 11
do_action( 'dgwt/wcas/indexer/update', $product_id );
do_action( 'dgwt/wcas/indexer/delete', $product_id );
```

--------------------------------

### Create Custom FiboSearch Endpoint

Source: https://fibosearch.com/documentation/troubleshooting/the-search-endpoint-url-is-blocked

Create a new index.php file in a dedicated directory to serve as a custom search endpoint.

```php
<?php
/**
* Custom FiboSearch endpoint
*/
define( 'SHORTINIT', true );
$wp_load = '../wp-load.php';
if ( file_exists( $wp_load ) ) {
require_once $wp_load;
$endpoint = '../wp-content/plugins/ajax-search-for-woocommerce-premium/includes/Engines/TNTSearchMySQL/Endpoints/search.php';
if ( file_exists( $endpoint ) ) {
require_once $endpoint;
}
}
```

```php
<?php /** * Custom FiboSearch endpoint */ define( 'SHORTINIT', true ); $wp_load = '../wp-load.php'; if ( file_exists( $wp_load ) ) { require_once $wp_load; $endpoint = '../wp-content/plugins/ajax-search-for-woocommerce-premium/includes/Engines/TNTSearchMySQL/Endpoints/search.php'; if ( file_exists( $endpoint ) ) { require_once $endpoint; } }
```

```php
<?php
/**
 * Custom FiboSearch endpoint
 */

define( 'SHORTINIT', true );

$wp_load = '../wp-load.php';

if ( file_exists( $wp_load ) ) {
    require_once $wp_load;
    $endpoint = '../wp-content/plugins/ajax-search-for-woocommerce-premium/includes/Engines/TNTSearchMySQL/Endpoints/search.php';
    if ( file_exists( $endpoint ) ) {
        require_once $endpoint;
    }
}
```

--------------------------------

### Configure Basic Auth Credentials for FiboSearch

Source: https://fibosearch.com/documentation/troubleshooting/always-displays-all-products-on-the-search-results-page

Add these constants to your wp-config.php file to allow the plugin to authenticate when the site is protected by basic auth.

```php
define( 'DGWT_WCAS_BA_USERNAME', 'YOUR_USER' );
define( 'DGWT_WCAS_BA_PASSWORD', 'YOUR_PASSWORD' );
```

--------------------------------

### Always show 'Products' headline (FiboSearch Free)

Source: https://fibosearch.com/documentation/get-started/customize-search-appearance

This PHP snippet ensures the 'Products' headline is consistently shown in FiboSearch results for the free version. Include it in your WordPress theme's functions.php or a custom plugin.

```php
add_filter( 'dgwt/wcas/search_results/always_show_product_headline', '__return_true' );
```

--------------------------------

### Apply Menu Order Factor to Product Score

Source: https://fibosearch.com/documentation/tips-tricks/how-to-change-the-order-of-search-results

This snippet multiplies the existing product search score by the calculated menu order factor. This should be implemented in SHORTINIT mode, typically within the fibosearch.php file.

```php
<?php

// [SHORTINIT MODE] Run this snippet in the SHORTINIT mode (fibosearch.php file). Take a look at the Implementation section above.

add_filter( 'dgwt/wcas/tnt/product/score', function ( $score, $product_id, $product ) {
	$factor = isset( $product->meta['menu_order_factor'] ) ? (float) $product->meta['menu_order_factor'] : 0;
	return $score * $factor;
}, 10, 3 );
```

--------------------------------

### Check FiboSearch JavaScript registration

Source: https://fibosearch.com/documentation/troubleshooting/search-bar-is-not-responding

Run this command in the browser console to verify if the FiboSearch script is loaded. A result of 0 indicates the script is missing or deregistered.

```javascript
jQuery('#jquery-dgwt-wcas-js').length;
```

--------------------------------

### Enable Mobile Overlay via Shortcode

Source: https://fibosearch.com/documentation/get-started/using-a-fibosearch-shortcode

Use the 'mobile_overlay' parameter set to '1' to enable an overlay view on mobile devices, simplifying the interface to just the input box and results. This overrides the global setting.

```html
[fibosearch mobile_overlay="1"]
```

--------------------------------

### Always show 'See all results' link (FiboSearch Pro)

Source: https://fibosearch.com/documentation/get-started/customize-search-appearance

This PHP snippet forces the 'See all results' link to always be visible in FiboSearch, regardless of the number of matching products. It's intended for use in SHORTINIT mode.

```php
<?php

// [SHORTINIT MODE]

add_filter( 'dgwt/wcas/search_results/show_more_products_link', '__return_true' );
```

--------------------------------

### Set FiboSearch Layout with Breakpoint via Shortcode

Source: https://fibosearch.com/documentation/get-started/using-a-fibosearch-shortcode

Combine the 'layout' parameter with 'layout_breakpoint' to define a specific screen width at which the layout will switch between icon and search bar. This overrides the global setting.

```html
[fibosearch layout="flex-icon-on-mobile" layout_breakpoint="800"]
```

```html
[fibosearch layout="flex-icon-on-desktop" layout_breakpoint="800"]
```

--------------------------------

### Listen to FiboSearch events with plain JavaScript

Source: https://fibosearch.com/documentation/developers/javascript-events

Use the native addEventListener method on the document object to handle FiboSearch events.

```javascript
document.addEventListener('fibosearch/no-results', (e) => {
    // do your stuff here
});
```

--------------------------------

### Activate Mobile Overlay via Shortcode

Source: https://fibosearch.com/documentation/features/overlay-on-mobile

Use these shortcodes to force the mobile overlay design, overriding global plugin settings for specific search bars.

```shortcode
[fibosearch mobile_overlay="1" ]
```

```shortcode
[fibosearch mobile_overlay="1" mobile_overlay_breakpoint="768" ]
```

--------------------------------

### Demote products during search

Source: https://fibosearch.com/documentation/tips-tricks/how-to-change-the-order-of-search-results

Reduces the search score for products marked as out of stock. This snippet should be run in SHORTINIT mode.

```php
<?php

// [SHORTINIT MODE] Run this snippet in the SHORTINIT mode (fibosearch.php file). Take a look at the Implementation section above.

add_filter( 'dgwt/wcas/tnt/product/score', function ( $score, $product_id, $product ) {
	if ( ! empty( $product->meta['out_of_stock'] ) ) {
		$score -= 100;
	}
	return $score;
}, 10, 3 );
```

--------------------------------

### Enable Mobile Overlay with Breakpoint via Shortcode

Source: https://fibosearch.com/documentation/get-started/using-a-fibosearch-shortcode

The 'mobile_overlay_breakpoint' parameter, when used with 'mobile_overlay="1"', allows you to specify a custom screen width below which the overlay will be active. This overrides the global setting.

```html
[fibosearch mobile_overlay="1" mobile_overlay_breakpoint="480"]
```

--------------------------------

### Boost Product Score Based on Custom Field Match

Source: https://fibosearch.com/documentation/tips-tricks/how-to-change-the-order-of-search-results

This snippet boosts the search score for products where the search query keywords match the product's custom field value (e.g., 'product_year'). This code must be run in SHORTINIT mode. It's Step 3 of the process.

```php
<?php

// [SHORTINIT MODE] Run this snippet in the SHORTINIT mode (fibosearch.php file). Take a look at the Implementation section above.

add_filter( 'dgwt/wcas/tnt/product/score', function ( $score, $product_id, $product, $query ) {
	if ( ! empty( $product->meta['product_year'] ) ) {
		$field    = $product->meta['product_year'];
		$keywords = $query->breakIntoTokens( $query->getPhrase() );

		if ( ! empty( $keywords ) ) {
			foreach ( $keywords as $keyword ) {
				if ( ! empty( $keyword ) && $keyword === $field ) {
					$score += 50;
				}
			}
		}
	}

	return $score;
}, 10, 4 );
```

--------------------------------

### Manage FiboSearch Index via WP-CLI

Source: https://fibosearch.com/documentation/developers/indexing

Use these WP-CLI commands to manually rebuild, update, or delete items from the FiboSearch index, or to retrieve status information.

```bash
# Rebuilding the entire index
wp fibosearch index build [--show-logs] [--hide-progress] [--disable-parallel]

# Update or delete the indicated posts in the index
# <id>: One or more IDs of posts to update in index (comma-separated)
wp fibosearch index delete <id> [--hide-progress]
wp fibosearch index update <id> [--hide-progress]

# Other commands
wp fibosearch index get-info status
wp fibosearch index show-logs
```

--------------------------------

### Search Products by Reviews

Source: https://fibosearch.com/documentation/tips-tricks/adding-non-standard-data-to-the-search-index

This code snippet adds product reviews to the search index. It retrieves up to 20 approved reviews per product and includes their content in the search results. To index all reviews, change the 'number' parameter to -1. After adding the code, rebuild the FiboSearch index.

```php
add_filter( 'dgwt/wcas/tnt/source_query/data', function ( $data, $sourceQuery, $onlyIDs ) {
	if ( empty( $data ) || ! is_array( $data ) ) {
		return $data;
	}

	if ( $onlyIDs ) {
		return $data;
	}

	foreach ( $data as $index => $row ) {
		$product_id = $row['ID'];

		$reviews = get_comments( array(
			'post_id' => $product_id,
			'status'  => 'approve',
			'type'    => 'review',
			'number'  => 20,
		) );
		
		$review_content = '';

		if ( ! empty( $reviews ) ) {
			foreach ( $reviews as $review ) {
				$review_content .= ' ' . $review->comment_content;
			}
			$data[ $index ]['product_reviews'] = trim( $review_content );
		}
	}

	return $data;
}, 15, 3 );
```

--------------------------------

### Add FiboSearch using PHP Shortcode

Source: https://fibosearch.com/documentation/get-started/how-to-add-fibosearch-to-your-website

Include FiboSearch in your PHP files using the `do_shortcode` function with the basic `[fibosearch]` shortcode. Ensure the shortcode is correctly enclosed within PHP tags.

```php
<?php echo do_shortcode('[fibosearch]'); ?>
```

--------------------------------

### Mark products for promotion by category

Source: https://fibosearch.com/documentation/tips-tricks/how-to-change-the-order-of-search-results

Use this filter to add a 'promote' meta field to products belonging to a specific category in the search index.

```php
add_filter( 'dgwt/wcas/tnt/indexer/readable/product/data', function ( $data, $product_id ) {
$your_category_slug = 'your-category-slug'; // Replace with yours
if ( has_term( $your_category_slug, 'product_cat', $product_id ) ) {
$data['meta']['promote'] = true;
}
return $data;
}, 10, 2 );
```

```php
add_filter( 'dgwt/wcas/tnt/indexer/readable/product/data', function ( $data, $product_id ) { $your_category_slug = 'your-category-slug'; // Replace with yours if ( has_term( $your_category_slug, 'product_cat', $product_id ) ) { $data['meta']['promote'] = true; } return $data; }, 10, 2 );
```

```php
add_filter( 'dgwt/wcas/tnt/indexer/readable/product/data', function ( $data, $product_id ) {
	$your_category_slug = 'your-category-slug'; // Replace with yours
	if ( has_term( $your_category_slug, 'product_cat', $product_id ) ) {
		$data['meta']['promote'] = true;
	}
	return $data;
}, 10, 2 );
```

--------------------------------

### Listening to FiboSearch JS Events

Source: https://fibosearch.com/documentation/developers/javascript-events

This section explains how to listen to FiboSearch JavaScript events using both jQuery and plain JavaScript.

```APIDOC
## Listening to FiboSearch JS Events

You can listen to FiboSearch JS events to trigger custom actions.

### Using jQuery

To listen for events using jQuery, you can use the `jQuery( document ).on()` method.

#### Example: `fibosearch/open` event

```javascript
jQuery( document ).on( 'fibosearch/open', () => {
    // do your stuff here
} );
```

### Using Plain JavaScript

To listen for events using plain JavaScript, you can use the `document.addEventListener()` method.

#### Example: `fibosearch/no-results` event

```javascript
document.addEventListener('fibosearch/no-results', (e) => {
    // do your stuff here
});
```
```

--------------------------------

### Create Custom Search Results Template

Source: https://fibosearch.com/documentation/troubleshooting/the-search-results-page-created-in-elementor-doesnt-display-products

Create an empty `fibosearch-search-results.php` file in your child theme's root and paste this code to define a custom Elementor template for search results. Replace `100` with your actual Elementor template ID.

```php
<?php
get_header( 'shop' );

$frontend    = new \Elementor\Frontend();
$template_id = 100; // Your search results template ID

echo \Elementor\Plugin::instance()->frontend->get_builder_content_for_display( $template_id, true );

get_footer( 'shop' );

```
Tokens:
Raw