Solr Search for WordPress

Contributors: getpantheon, Outlandish Josh, 10up, collinsinternet, andrew.taylor
Tags: search
Requires at least: 4.2
Tested up to: 4.6.1
Stable tag: 0.5.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
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 instance for the plugin to work as expected.

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:

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

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

<?php

putenv( 'PANTHEON_INDEX_HOST=192.168.50.4' ); // Replace with the appropriate IP address
putenv( 'PANTHEON_INDEX_PORT=8983' );

add_filter( 'solr_scheme', function(){ return 'http'; });

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!

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 [--posts_per_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.

Changelog

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

Ritesh-patel/solr-power