Daniel Bachhuber

10up

Chris Reynolds

John Spellman

Pantheon Systems

Allan Collins

Andrew Taylor

pwtyler

Josh Koenig

MikeNGarrett

Matthew Leffler

<p><a href="https://circleci.com/gh/pantheon-systems/solr-power" rel="nofollow ugc"></a></p>
<p>Search is critical for your site, but the default search for WordPress leaves a lot to be desired. Improve your user experience with the Apache Solr search engine for your WordPress website.</p>
<ul>
<li>Fast results, with better accuracy.</li>
<li>Enables faceting on fields such as tags, categories, author, and page type.</li>
<li>Indexing and faceting on custom fields.</li>
<li>Drop-in support for <a href="https://codex.wordpress.org/Class_Reference/WP_Query" rel="nofollow ugc">WP_Query</a> with the <code>solr_integrate</code> parameter set to true.</li>
<li>Completely replaces default WordPress search, just install and configure.</li>
<li>Completely integrated into default WordPress theme and search widget.</li>
<li>Very developer-friendly: uses the modern <a href="http://www.solarium-project.org/" rel="nofollow ugc">Solarium</a> library</li>
</ul>
<h3>Development</h3>
<p>This plugin is under active development on GitHub:</p>
<p><a href="https://github.com/pantheon-systems/solr-power" rel="nofollow ugc">https://github.com/pantheon-systems/solr-power</a></p>
<p>Please feel free to file issues there. Pull requests are also welcome! See <a href="https://github.com/pantheon-systems/solr-power/blob/main/CONTRIBUTING.md" rel="nofollow ugc">CONTRIBUTING.md</a> for information on contributing.</p>
<p>For further documentation, such as available filters and working with the <code>SolrPower_Api</code> class directly, please see the project wiki:</p>
<p><a href="https://github.com/pantheon-systems/solr-power/wiki" rel="nofollow ugc">https://github.com/pantheon-systems/solr-power/wiki</a></p>
<p>You may notice there are two sets of tests running, on two different services:</p>
<ul>
<li><a href="https://phpunit.de/" rel="nofollow ugc">PHPUnit</a> test suite against a Solr instance.</li>
<li>The <a href="http://behat.org/" rel="nofollow ugc">Behat</a> test suite against a Pantheon site, to ensure the plugin’s compatibility with the Pantheon platform.</li>
</ul>
<p>Both of these test suites can be run locally, with a varying amount of setup.</p>
<p>PHPUnit requires the <a href="https://make.wordpress.org/core/handbook/testing/automated-testing/phpunit/" rel="nofollow ugc">WordPress PHPUnit test suite</a>, and access to a database with name <code>wordpress_test</code>. If you haven’t already configured the test suite locally, you can run <code>bash bin/install-wp-tests.sh wordpress_test root '' localhost</code>. You’ll also need access to a running Solr instance, in order to run the unit tests against Solr.</p>
<p>Behat requires a Pantheon site with Solr enabled. Once you’ve created the site, you’ll need <a href="https://github.com/pantheon-systems/terminus#installation" rel="nofollow ugc">install Terminus</a>, and set the <code>TERMINUS_TOKEN</code>, <code>TERMINUS_SITE</code>, and <code>TERMINUS_ENV</code> environment variables. Then, you can run <code>./bin/behat-prepare.sh</code> to prepare the site for the test suite.</p>
<p>Note that dependencies are installed via Composer and the <code>vendor</code> directory is not committed to the repository. You will need to run <code>composer install</code> locally for the plugin to function. You can read more about Composer <a href="https://getcomposer.org" rel="nofollow ugc">here</a></p>
<h3>WP-CLI Support</h3>
<p>This plugin has <a href="http://wp-cli.org/" rel="nofollow ugc">WP-CLI</a> support.</p>
<p>All Solr Power related commands are grouped into the <code>wp solr</code> command, see an example:</p>
<pre><code>$ wp solr
usage: wp solr check-server-settings
   or: wp solr delete [<id>...] [--all]
   or: wp solr index [--batch=<batch>] [--batch_size=<size>] [--post_type=<post-type>]
   or: wp solr info [--field=<field>] [--format=<format>]
   or: wp solr optimize-index
   or: wp solr repost-schema
   or: wp solr stats [--field=<field>] [--format=<format>]

See 'wp help solr <command>' for more information on a specific command.
</code></pre>
<p>You can see more details about the commands using <code>wp help solr</code>:</p>
<pre><code>**NAME**

  wp solr

**DESCRIPTION**

  Perform a variety of actions against your Solr instance.

**SYNOPSIS**

  wp solr <command>

**SUBCOMMANDS**

  check-server-settings      Check server settings.
  delete                     Remove one or more posts from the index.
  index                      Index all posts for a site.
  info                       Report information about Solr Power configuration.
  optimize-index             Optimize the Solr index.
  repost-schema              Repost schema.xml to Solr.
  stats                      Report stats about indexed content.<h3>WP_Query Integration</h3>
</code></pre>
<p>Use Solr in a custom WP_Query instead of querying a database. Add <code>'solr_integrate' => true</code> to the query arguments.</p>
<p><strong>NOTE:</strong> Currently, only basic queries, tax_query, meta_query and date_query are supported. See <code>examples/example.custom_WP_Query.php</code> for an example.</p>
<p>A meta_query can use the following compare operators:</p>
<ul>
<li><code>'='</code></li>
<li><code>'!='</code></li>
<li><code>'>'</code></li>
<li><code>'>='</code></li>
<li><code>'<'</code></li>
<li><code>'<='</code></li>
<li><code>'LIKE'</code></li>
<li><code>'NOT LIKE'</code></li>
<li><code>'IN'</code></li>
<li><code>'NOT IN'</code></li>
<li><code>'BETWEEN'</code></li>
<li><code>'NOT BETWEEN'</code></li>
<li><code>'EXISTS'</code></li>
<li><code>'NOT EXISTS'</code></li>
</ul>
<p>(<code>'REGEXP'</code>, <code>'NOT REGEXP'</code>, and <code>'RLIKE'</code> are not supported.)</p>
<h3>Configuration Tips</h3>
</p>
<p><h4>Searching by author name</h4>
</p>
<p>To support searching by author name (e.g. where “Pantheon” would return posts authored by the “Pantheon” user), add the following to your custom <code>schema.xml</code>:</p>
<pre><code>  <copyField source="post_author" dest="text"/>
</code></pre>
<p><h4>Boosting relevancy score by publish date</h4>
</p>
<p>The following guidance can be used to extend the Solr index and modify boosts beyond just this example.</p>
<p>To support math functions on dates, you must add a custom <code>schema.xml</code> to Solr and <strong>reindex with the new schema</strong>.</p>
<p>Add the following to <code>schema.xml</code>:</p>
<pre><code>  
  
  <fieldType name="tdate" class="solr.TrieDateField" omitNorms="true" precisionStep="6" positionIncrementGap="0"/>

  
  <field name="post_date_iso" type="tdate" indexed="true" stored="true" required="true" />
</code></pre>
<p>Add the following to your <code>functions.php</code> file.</p>
<pre><code>  <?php
  /**
   * Hooks into the document build process to add post date field in proper format.
   */
  function my_solr_build_document( $doc, $post_info ) {
        $post_time = strtotime( $post_info->post_date );
        // Matches format required for TrieDateField
        $doc->setField( 'post_date_iso', gmdate( 'c\Z', $post_time ) );
        return $doc;
  }
  add_filter( 'solr_build_document', 'my_solr_build_document', 10, 2 );

  /**
   * Hooks into query processor, Dismax, to add publish date boost.
   * See: https://www.metaltoad.com/blog/date-boosting-solr-drupal-search-results
   */
  function my_solr_dismax_query( $dismax ) {
        $dismax->setQueryParser( 'edismax' );
        $dismax->setBoostQuery( 'recip(abs(ms(NOW/HOUR,post_date_iso),3.16e-11,1,1))' );
        return $dismax;
  }
  add_filter( 'solr_dismax_query', 'my_solr_dismax_query' );
</code></pre>
<p><h4><code>is_solr_query</code> Filter</h4>
</p>
<p>The <code>is_solr_query</code> filter controls whether Solr should be used for a specific query.</p>
<p>Parameters:</p>
<ul>
<li>$enabled (bool): Indicates whether Solr should be used for the query. Defaults to true if the query is a search or if solr_integrate is set in the query.</li>
<li>$query (WP_Query): The current WordPress query object.</li>
</ul>
<p>Return:</p>
<ul>
<li>
<p>bool: true to enable Solr for the query, false to disable it.</p>
<p>add_filter( ‘is_solr_query’, function( $enabled, $query ) {<br />
    if ( $query->is_category( ‘news’ ) ) {<br />
        return false;<br />
    }<br />
    return $enabled;<br />
}, 10, 2 );</p>
</li>
</ul>
<p><h4>Custom schema file path</h4>
</p>
<p>By default, custom schema is sourced from <code>wp-content/uploads/solr-for-wordpress-on-pantheon/schema.xml</code>. This can be overridden with an absolute path using the the <code>solr_power_customer_schema_file_path</code> filter.</p>
<p>Parameters:<br />
* $custom_schema_file_path (string): Default path to a custom schema file</p>
<p>Return:<br />
* string: Absolute path to a custom schema.xml file.</p>
<pre><code>add_filter('solr_power_customer_schema_file_path', function($custom_schema_file_path) {
    return '/absolute/path/to/schema.xml';
});
</code></pre>
<p><h4>Common issues</h4>
</p>
<ul>
<li>Failing to post the schema.xml will result in an error during indexing, “Missing <code>post_date_iso</code> field.”</li>
<li>If you have the field and type in the schema, but don’t add the <code>solr_build_document</code> filter, you will get a similar error.</li>
<li>If the <code>post_date_iso</code> field is missing from the index, Solr will ignore this boost and return regular results.</li>
<li>Trying to use a regular date field for the boost query will result in an error in the request instead of results.</li>
</ul>
<p><h4>Explicit Commit vs Autocommit</h4>
</p>
<p>Once solr has sent the data to the solr server, solr must COMMIT the data to the index and adjust the index and relevancy ratings accordingly before that data can appear in search results.</p>
<p>By default, Solr Search for WordPress has auto-commit disabled. The index is committed when the uncommitted item is two minutes old, or the cron runs. By default, the cron runs on the Pantheon platform every hour.</p>
<p>When autocommit is enabled, Solr Search for WordPress commits data when it sends every post. When running on Pantheon, we recommend leaving autocommit disabled to aid overall site performance.</p>
<p>To enable autocommit, add the following to <code>wp-config.php</code> or an mu-plugin.</p>
<pre><code>  define( 'SOLRPOWER_DISABLE_AUTOCOMMIT', false );
</code></pre>
<p>To force-commit data outside of a normal cron run, from the command line, you can run the command below or simply force a cron-run.</p>
<pre><code>  wp solr commit
</code></pre>

Solr Search for WordPress


This plugin is intended for use with sites hosted on Pantheon, and may not work with other hosting platforms.



This plugin replaces the default search mechanism within WordPress while preserving the familiar integration methods within themes and widgets.  The plugin also included a widget that you can use to integrate with the current theme


Awesome, work !!!

Improve your user experience with the Apache Solr search engine for your WordPress website.

Mikko Saari

<p>Relevanssi replaces the standard WordPress search with a better search engine, with lots of features and configurable options. You’ll get better results, better presentation of results – your users will thank you.</p>
<p>This is the free version of Relevanssi. There’s also Relevanssi Premium, which has added features. For more information about Premium, see <a href="https://www.relevanssi.com/" rel="nofollow ugc">Relevanssi.com</a>.</p>
<p>Do note that using Relevanssi may require large amounts (hundreds of megabytes) of database space (for a reasonable estimate, multiply the size of your <code>wp_posts</code> database table by three). If your hosting setup has a limited amount of space for database tables, using Relevanssi may cause problems. In those cases use of Relevanssi cannot be recommended.</p>
<h4>Key features</h4>
<ul>
<li>Search results sorted in the order of relevance, not by date.</li>
<li>Fuzzy matching: match partial words, if complete words don’t match.</li>
<li>Find documents matching either just one search term (OR query) or require all words to appear (AND query).</li>
<li>Search for phrases with quotes, for example “search phrase”.</li>
<li>Create custom excerpts that show where the hit was made, with the search terms highlighted.</li>
<li>Highlight search terms in the documents when user clicks through search results.</li>
<li>Search comments, tags, categories and custom fields.</li>
<li>Multisite friendly.</li>
<li>bbPress support.</li>
<li>Gutenberg friendly.</li>
</ul>
<h4>Advanced features</h4>
<ul>
<li>Adjust the weighting for titles, tags and comments.</li>
<li>Log queries, show most popular queries and recent queries with no hits.</li>
<li>Restrict searches to categories and tags using a hidden variable or plugin settings.</li>
<li>Index custom post types and custom taxonomies.</li>
<li>Index the contents of shortcodes.</li>
<li>Google-style “Did you mean?” suggestions based on successful user searches.</li>
<li>Support for <a href="http://wpml.org/" rel="nofollow ugc">WPML multi-language plugin</a> and <a href="https://wordpress.org/plugins/polylang/" rel="ugc">Polylang</a>.</li>
<li>Support for <a href="http://www.s2member.com/" rel="nofollow ugc">s2member membership plugin</a>, <a href="https://wordpress.org/plugins/members/" rel="ugc">Members</a>, <a href="https://wordpress.org/plugins/groups/" rel="ugc">Groups</a>, <a href="https://wordpress.org/plugins/simple-membership/" rel="ugc">Simple Membership</a> and other membership plugins.</li>
<li>Advanced filtering to help hacking the search results the way you want.</li>
<li>Search result throttling to improve performance on large databases.</li>
<li>Disable indexing of post content and post titles with a simple filter hook.</li>
</ul>
<h4>Premium features (only in Relevanssi Premium)</h4>
<ul>
<li>Indexing attachment content (PDF, Office, Open Office).</li>
<li>Improved spelling correction in “Did you mean?” suggestions.</li>
<li>Searching across multiple sites in the same multisite installation.</li>
<li>Search and index user profiles.</li>
<li>Search and index taxonomy term pages (categories, tags, custom taxonomies).</li>
<li>Search and index arbitrary columns in wp_posts MySQL table.</li>
<li>Assign weights to any post types and taxonomies.</li>
<li>Assign extra weight to new posts.</li>
<li>Let the user choose between AND and OR searches, use + and – operator (AND and NOT).</li>
<li>Export and import settings.</li>
<li><a href="https://www.relevanssi.com/user-manual/wp-cli/" rel="nofollow ugc">WP CLI commands</a>.</li>
<li><a href="https://www.relevanssi.com/knowledge-base/related-posts/" rel="nofollow ugc">Related posts</a>.</li>
<li><a href="https://www.relevanssi.com/user-manual/redirects/" rel="nofollow ugc">Redirects for searches</a>.</li>
</ul>
<h3>Thanks</h3>
<ul>
<li>Cristian Damm for tag indexing, comment indexing, post/page exclusion and general helpfulness.</li>
<li>Marcus Dalgren for UTF-8 fixing.</li>
<li>Warren Tape for 2.5.5 fixes.</li>
<li>Mohib Ebrahim for relentless bug hunting.</li>
<li>John Calahan for extensive 4.0 beta testing.</li>
</ul>


Relevanssi – A Better Search

I cannot understand why Relevanssi does not have more active installs, since the years it's the best plugin to sort the WP search results by Relevancy.

I would like to see 1 million installs soon, it deserves.

Best Plugin to improve the WordPress Search Engine

I rarely find a plugin that does exactly what I need, clearly and efficiently (therefore, I usually build it myself). The various but smooth settings allow a perfect fine tuning: nothing more and nothing less than what is really needed. My compliments!

Just perfect!

Relevanssi replaces the default search with a partial-match search that sorts results by relevance. It also indexes comments and shortcode content.

Solr Search for WordPress vs Relevanssi – A Better Search