trendwerk/search

Basic extensions for searching in WordPress.

Search

, _(*1)

Basic extensions for searching in WordPress., _(*2)

Quick links: Install | Usage | Dimensions | Example, _(*3)

Note: This basic extension is not very scalable and meant for smaller databases. This package could get slow for complex searches. In that case, Elasticsearch would be a better solution., _(*4)

Install

composer require trendwerk/search

Usage

1. Initialize package
2. Add search dimension(s)

Initialize

$search = new \Trendwerk\Search\Search();
$search->init();

This code should be run when bootstrapping your theme., _(*5)

Dimensions

Currently this package supports metadata and terms as search dimensions. Dimensions can be added by using addDimension:, _(*6)

$search->addDimension($dimension);

Meta

$metaDimension = new \Trendwerk\Search\Dimension\Meta($wpdb, [
    'key' => 'firstName',
]);

$search->addDimension($metaDimension);

Available options for constructing an instance of Meta:, _(*7)

Terms

$search->addDimension(new \Trendwerk\Search\Dimension\Term($wpdb, [
    'taxonomy' => 'taxonomyName',
]));

Available options for constructing an instance of Term:, _(*8)

Example

use Trendwerk\Search\Dimension\Meta;
use Trendwerk\Search\Dimension\Term;
use Trendwerk\Search\Search;

$search = new Search();
$search->init();

$search->addDimension(new Meta($wpdb, [
    'compare' => 'LIKE',
    'key'     => 'lastNames%',
]));

$search->addDimension(new Meta($wpdb, [
    'key' => 'firstName',
]));

$search->addDimension(new Term($wpdb, [
    'taxonomy' => 'category',
]));