Integrations / Platforms / WordPress / Getting Started
Feb. 22, 2019

Getting Started

Introduction

This documentation will help you create your own integration, the best way possible.

Algolia offers a WordPress plugin with some admin configuration. While it’s easy to use, the plugin does not offer full-scale customization. It’s designed only to enable you to make small modifications.

We strongly recommend that you follow this walk-through rather than installing the Algolia plugin.

To integrate Algolia to your WordPress instance, there are 3 main steps:

  1. Indexing your data
  2. Optimizing your relevance
  3. Building your front end search experience

For the indexing part, there are two ways to do it. Either you create a custom plugin, or you add this feature to your active theme.

Ideally, you want to create a plugin to hold all the generic code, so you can easily reuse this code for another blog or when we decide to use another theme. Unfortunately, since many features are built in the theme (such as custom post types or post meta) it’s hard to really keep things separated.

The best solution will be to create a plugin to do some plumbing work but to add in the theme all the content-related logic.

Requirements

This documentation assumes that you have some basic WordPress development knowledge. Typically, you know what a custom post type is, what post meta are, and how to use actions and filters. You must have basic PHP skills and be able to run a command from your terminal.

The following software must be installed:

  • PHP 5.3 or newer (version 7.1+ is highly recommended)
  • WordPress (up and running instance)
  • WP-CLI

Did you find this page helpful?