Index Schemas

Understand how we format the data pushed to Algolia.

Introduction

This plugin formats your data in an optimal and extensible format so that it can better serve your WordPress search experience.

On this page, you will find some explanations about how Algolia formats your data, how they configure your Algolia indices, and how you can customize it.

Posts

WordPress Posts core feature allows developers to easily create custom content types.

Every third party plugin offering new post types will automatically be available to the WP Search with Algolia plugin.

By default here are the attributes that get pushed to Algolia for every post:

Attribute Name	Description
objectID	The unique identifier for this record.
post_id	The unique identifier for the post.
post_type	The post type slug.
post_type_label	The post type nice-name.
post_title	The title of the post.
post_excerpt	The excerpt of the post. An empty string if not available.
post_date	The first publication date as a unix timestamp.
post_date_formatted	The post date formatted based on date_format option
post_modified	The last time the post was updated as a unix timestamp.
comment_count	The number of comments for the post.
menu_order	Position in the menu.
post_author	The post author as an array containing the author_ID, the display_namethe user_url and the user_login.
thumbnail_url	The url to the featured image of the post.
permalink	The url to the public page of the post.
post_mime_type	The Mime Type of the post, available only for Medias (attachments).
taxonomy_post_tag	An array of strings representing the post tags.
taxonomy_category	An array of strings representing categories the post is attached to.
is_sticky	1 if the post is marked as sticky, 0 otherwise.

The above attributes are what are called shared attributes.

Algolia is very performant when searching small chunks of text. As posts can become large pieces of text, there is a mechanism to split your posts into several smaller Algolia records.

Each record from a post will have the same shared attributes and content.

Attribute Name	Description
content	Content found in the bottom most hierarchical level in your post.

Terms

Since there are no large chunks of text in terms, there will be one record per term.

Here are the default attributes that are pushed push:

Attribute Name	Description
objectID	The unique identifier for this record.
term_id	The unique identifier for the term.
taxonomy	The taxonomy slug.
name	The term name.
description	The term description.
slug	The slug of the term.
posts_count	The number of times this term was assigned to a post.
permalink	The url to the public page of the term.

Users

There are no chunks of text for users, so there will be one record per user:

Attribute Name	Description
objectID	The unique identifier for this record.
user_id	The unique identifier for the user.
display_name	The display name for the user.
posts_url	URL to the page listing all posts of the author.
description	The bio of the author.
posts_count	The number of posts written by the user.
avatar_url	The URL of the user's avatar picture.