Solr Search for WordPress

Contributors: getpantheon, Outlandish Josh, 10up, collinsinternet, andrew.taylor
Tags: search
Requires at least: 4.6
Tested up to: 4.8
Stable tag: 1.4.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

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

Description

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.

Fast results, with better accuracy.
Enables faceting on fields such as tags, categories, author, and page type.
Indexing and faceting on custom fields.
Drop-in support for WP_Query with the "solr-integrate" parameter set to true.
Completely replaces default WordPress search, just install and configure.
Completely integrated into default WordPress theme and search widget.
Very developer-friendly: uses the modern Solarium library

Installation

The Solr Power plugin can be installed just like you'd install any other WordPress plugin. Because Solr Power is intended to be a bridge between WordPress and the Apache Solr search engine, you'll need access to a functioning Solr 3.6 instance for the plugin to work as expected. This plugin does not support other versions of Solr.

If you're using the Solr Power plugin on Pantheon, setting up Apache Solr is as easy as enabling the Apache Solr add-on in your Pantheon dashboard. Once you've done so:

Configure which post types, taxonomies and custom fields to index by going to the Indexing tab of the Solr Power settings page.
Index your existing content by going to the plugin options screen and selecting the applicable Actions:
- - Index Searchable Post Types
Search on!
See the examples/templates directories for more rich implementation guidelines.

If you're using the Solr Power plugin elsewhere, you'll need to install and configure Apache Solr. On a Linux environment, this involves four steps:

Install the Java Runtime Environment.
Run ./bin/install-solr.sh to install and run Apache Solr on port 8983.
Configuring Solr Power to use this particular Solr instance by setting the PANTHEON_INDEX_HOST and PANTHEON_INDEX_PORT environment variables.
Copying schema.xml to the Solr configuration directory (a path similar to solr/conf/schema.xml).

In a local development environment, you can point Solr Power to a custom Solr instance by creating a MU plugin with:

<?php
/**
 * Define Solr host IP, port, scheme and path
 * Update these as necessary if your configuration differs
*/
putenv( 'PANTHEON_INDEX_HOST=192.168.50.4' );
putenv( 'PANTHEON_INDEX_PORT=8983' );
add_filter( 'solr_scheme', function(){ return 'http'; });
define( 'SOLR_PATH', '/solr/wordpress/' );

Development

This plugin is under active development on GitHub:

https://github.com/pantheon-systems/solr-power

Please feel free to file issues there. Pull requests are also welcome!

For further documentation, such as available filters and working with the SolrPower_Api class directly, please see the project wiki:

https://github.com/pantheon-systems/solr-power/wiki

You may notice there are two sets of tests running, on two different services:

Travis CI runs the PHPUnit test suite against a Solr instance.
Circle CI runs the Behat test suite against a Pantheon site, to ensure the plugin's compatibility with the Pantheon platform.

Both of these test suites can be run locally, with a varying amount of setup.

PHPUnit requires the WordPress PHPUnit test suite, and access to a database with name wordpress_test. If you haven't already configured the test suite locally, you can run bash bin/install-wp-tests.sh wordpress_test root '' localhost. You'll also need access to a running Solr instance, in order to run the unit tests against Solr.

Behat requires a Pantheon site with Solr enabled. Once you've created the site, you'll need install Terminus, and set the TERMINUS_TOKEN, TERMINUS_SITE, and TERMINUS_ENV environment variables. Then, you can run ./bin/behat-prepare.sh to prepare the site for the test suite.

Note that dependencies are installed via Composer and the vendor directory is not committed to the repository. You will need to run composer install locally for the plugin to function. You can read more about Composer here

WP-CLI Support

This plugin has WP-CLI support.

All Solr Power related commands are grouped into the wp solr command, see an example:

$ wp solr
usage: wp solr check-server-settings
   or: wp solr delete [<id>...] [--all]
   or: wp solr index [--page] [--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.

You can see more details about the commands using wp help solr:

**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.

WP_Query Integration

Use Solr in a custom WP_Query instead of querying a database. Add 'solr_integrate' => true to the query arguments.

NOTE: Currently, only basic queries, tax_query, meta_query and date_query are supported. See examples/example.custom_WP_Query.php for an example.

A meta_query can use the following compare operators:

'='
'!='
'>'
'>='
'<'
'<='
'LIKE'
'NOT LIKE'
'IN'
'NOT IN'
'BETWEEN'
'NOT BETWEEN'
'EXISTS'
'NOT EXISTS'

('REGEXP', 'NOT REGEXP', and 'RLIKE' are not supported.)

Configuration Tips

Searching by author name

To support searching by author name (e.g. where "Pantheon" would return posts authored by the "Pantheon" user), add the following to your custom schema.xml:

<copyField source="post_author" dest="text"/>

Changelog

1.4.0

Bumps minimum supported version to WordPress 4.6.
Updates bundled Solarium library to 3.8.1.
Fixes Solr queries using orderby=>meta_value_num [#299].
Use $_SERVER['HOME'] as a reliable way of finding the cert on Pantheon [#314].

1.3.0

Add .distignore file for wp dist-archive solr-power
Make Solr in the admin opt-in only using the solr_allow_admin filter
Error early when PANTHEON_ENVIRONMENT isn't set
Clarify error message when environment variables aren't set
Mention copying schema.xml and supported Solr version in README
Include original plugin attribution in the copyright notice
Boost post_title more than post_content with sane boost values
Add missing filter for custom fields
Boost posts with matching titles to the top of results
Remove duplicate options when initializing them
Match author name in search results
Bug fixes
Adhere to WordPress coding standards in PHP files

1.2.0

Add multisite support
Respect all query vars when searching with WP_Query
Display error from schema submit response when Solr includes one

1.1.0

Introduce a new class for managing batch indexes
Rewrite wp solr index to provide more verbosity
Make batch indexes resumeable by logging paged to an option
Remove old wp solr index code
Fire solr_power_index_all_finished action when indexing is complete
Ensure a completion message displays after indexing is complete
Fix a bug around Solr taking over searches in wp-admin
Properly apply the solr_allow_admin and solr_allow_ajax filters
Add solr_boost_query filter for boosted items
Add solr_dismax_query filter for Dismax
Add get_post_types and get_post_statuses helper methods
Remove unnecessary get_env call
Add solr_post_status filter
Add missing solr_post_types filter to get_post_types call
Use PANTHEON_INDEX_PORT instead of hard-coded port in curl

1.0.0

Add Ajax functionality to the facet search widget
Add date_query support to WP_Query Integration
Allow s parameter for WP_Query when Solr is enabled
Checks for searchable post type before indexing modified post
Test with WordPress 4.7
Add solr_power_index_all_finished action when indexing all posts is complete
Allow post_title and post_content to score higher
Make sure that integers and float values are actually of that type. Otherwise, Solr will fail to index the document.

0.6.0

Advanced WP_Query Integration - Meta Queries, Tax Queries
Translatable strings standardized
Facet query fixes
Hide schema submit option if not on the Pantheon platform
Added a method for API status
Document available filters
Fixed single quote/character issues in the facet widget

0.5.0

Add facet search widget
Update options page internals to utilize WordPress settings API
Add Behat tests to ensure the plugin's compatibility with the Pantheon platform.
Defork Solarium and update it to version 3.6.0

0.4.1

Do not allow plugin activation if the PANTHEON_INDEX_HOST or PANTHEON_INDEX_PORT environment variables are not set. Instead, show an admin notice to the user advising them to configure the environment variables.

0.4

Auto submission of schema.xml
Moved legacy functions to a separate file
PHP version check - warn in the WordPress dashboard and disable Solr Power plugin if the PHP version is less than 5.4

0.3

Bug fixes
Settings page updates
Filters for AJAX/Admin integration
Indexing all publicly queryable post types
Debug Bar Extension
Default sort option on settings page
Initial WP CLI integration

0.2

Works "out of the box" by overriding WP_Query()
Much improved internal factoring

0.1

Initial alpha release (GitHub only)

0.0

Note this started as a fork of this wonderful project: https://github.com/mattweber/solr-for-wordpress

ClockworkNet/solr-power