Install Lift

After downloading Lift, Search for WordPress, you will need to install the plugin. There are three ways to do this:

Install Lift by searching the WordPress.org plugin repository:

  1. Log in to your WordPress admin dashboard.
  2. Click the "Plugins" menu and enter Lift into the search box.
  3. Select Lift Search for WordPress and click "Install Now."
  4. You will receive a confirmation message when the plugin finishes installing.

Install Lift by uploading the plugin through your WordPress Dashboard:

  1. Log in to your WordPress admin dashboard.
  2. Click the "Plugins" menu and choose "Add New" from the top menu.
  3. Click "Choose File", locate the LiftSearchforWordPress.zip file and click "Install Now."
  4. You will receive a confirmation message when the plugin finishes installing.

Install Lift manually:

  1. Unzip the LiftSearchforWordPress.zip that you downloaded.
  2. Upload the contents of LiftSearchforWordPress.zip into your plugins directory

Set-up Amazon

To use Lift you will need an Amazon Web Services account. AWS CloudSearch is a paid service and will require a credit card. You should take some time to look over the documentation- especially the sections on CloudSearch.

If you have an Amazon Web Services account:

  1. Log in with your account username and password.
  2. Click on the "My Account / Console" link in top right corner of the header. Click on "Security Credentials" to view your Access Key ID and your Secret Access key.
  3. Copy these to a text document to reference for plugin activation.

If you do not have an Amazon Web Services account:

  1. Visit the Amazon Web Services page and create an account.
  2. Since AWS is not free, you will need to enter your payment and billing information.
  3. There will be identity verification by telephone.
  4. Once confirmed, you can log in with your account username and password.
  5. Click on the "My Account / Console" link in top right corner of the header. See above.
  6. Click on "Security Credentials" to view your Access Key ID and your Secret Access key. Copy these to a text document to reference for plugin activation. See above.

Configure Lift

Before you can start using Lift, the plugin needs to be activated and configured.

Activate the plugin

  1. If you have not done so already, log in to your WordPress admin dashboard.
  2. Go to the "Plugins" menu item on left-hand side of the dashboard.
  3. Find the Lift plugin and click "Activate."
  4. A "Set-up Lift" banner will appear. Click this, and you will be taken to the Lift set-up page.

Set-up the plugin

  1. Enter Amazon access key that you recorded earlier. If you haven't done this, see the Set-up Amazon section above.
  2. Enter Amazon secret access key.
  3. Click "Save and Test My Configuration." If the test fails, check that both of your keys are entered correctly and that you are connected to Amazon.
  4. Enter a search domain name. This must be a unique string to your AWS account. The domain name string can only contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed. The string has a max length of 28 characters.

    Click "Save Domain". If the domain does not exist, Lift will ask if you would like the domain created for you. Click "yes" and the plugin will create and configure everything for you.

  5. Once the tests are successful, you're now ready to go. Click "Save and Index My Content" and Lift will begin to index your site. This can take a few hours depending on the amount of content on your site.

Customize Lift

After installation and configuration, Lift will use your theme's default search template to provide CloudSearch results with no customization needed.

Lift provides the following additional features:

  • A custom search form
  • Custom search results
  • A sidebar widget
  • Customizable front-end styling
  • Modifying the post types which are indexed

Use the instructions below to customize Lift's additional features to work with your theme.

Lift's search form adds date, post type, and sorting filters to your search returns. These can be seen below:

To use Lift's search form, you'll need to add the following template tag to your header or sidebar. You'll need to to remove the default WordPress tag.

<?php
    if( function_exists("lift_search_form") ){
        lift_search_form();
    }
?>
Customize Search Form Filters:

The Lift Search Form provides several WordPress filters to modify the search form filters and their contents:

lift_filters_default_fields
Adds or removes fields from the search filters.
lift_filters_form_field_objects
Modifies the form field objects (search filter selections).
lift_search_form

This modifies the output of lift_search_form(). For example, you can prepend the form with a header tag. As shown below:

add_filter('lift_search_form', function($html){
    return "<h2>My Custom Header</h2>" . $html;
});

Enhance Your Search Template With Lift's Search Results

If you want to use Lift's search results in your current look-and-feel you need to replace the loop in your theme's search.php template with the following. This should replace the code block that typically looks like: <?php if ( have_posts() ) : ?> [rest of loop template] <?php endif; ?>

<?php
    if( function_exists("lift_loop") ){
        lift_loop();
    }
?>

Add a Lift Search Sidebar Widget

Lift includes a search form widget. You can add this to your sidebar by navigating to the Widgets admin page (Appearance > Widgets).

Front End Styling

If you are using the Lift search form or Lift results, you can open the lift-styles.css in your text editor and edit the commented lines.

NOTE: Thumbnail images will auto-size in the WordPress theme (if you're using the search results loop).

Modifying Indexed Post Types

By default, Lift will index posts and pages. To change this-- for example to add custom post types or prevent a post type from being indexed--use the lift_indexed_post_types filter.

For example, to add a custom post type named my-custom-post-type to be indexed:

add_filter('lift_indexed_post_types', function( $post_types ){
    $post_types[] = 'my-custom-post-type';
    return $post_types;
});

Lift's Dashboard

You can find the Lift dashboard under the WordPress admin's "Settings" menu.

Plugin Status

  • All Clear (green) - The CloudSearch index is active and there were no recent errors syncing documents.
  • Warning (yellow) - The CloudSearch index is in a state that prevents new documents from being synced or the plugin has had some recent sync failures. Please check the error message and index log below.
  • Critical (red) - The CloudSearch index is offline or there have been continued document syncing errors. Please check the error message and index log below.

CloudSearch Index Sync Controls and Displays

In the center you will find the controls for the automatic document syncing. These control the time interval between batches. You can change the interval, turn automatic indexes on and off and force an index to run. You can also get to Lift Settings.

Last/Next sync Displays
At the top, you can see when documents were last synced the next scheduled time to sync the queue.
Auto-update Field
Lets you control the delay between syncing documents to CloudSearch. If you choose to reset this, be sure to hit the "Save" button below.
Sync Queue Now Button
Allows you to manually sync any queued documents.
On/Off Buttons
Shows the status of automatic document syncing. It defaults to "On." If you are experiencing syncing errors, you have the ability to turn off the automatic syncing. If it's off, you will need to manually sync.
Settings button
Takes you to the Lift plugin set-up page.

The Documents to be Synced Window and Log Window

The Documents to be Synced Window
This shows the queue of Documents waiting to be synced in the next scheduled sync. Displays these post details: Queue ID, Post, Last Author and Time Queued
The Recent Logs Window
This displays any errors that occur during content processing. You should check here when Lift shows a warning or critical status
The Clear Logs Button
This clears the Log Window and returns Lift's status to all clear.
The View All Button
This will display all the logs form indexing