Actions Reference

The available actions and how to use them.

Algolia Search plugin for WordPress is no longer supported. Please use our API client guide instead.
Please note that if you already have the plugin set up and are satisfied with your current integration, you can keep using the plugin forever, knowing that it won’t be supported. It will still work as is, in its current state, on your website.
If you want to know more, click here.

Introduction

Actions are a way to execute code at a given point in time throughout the lifecyle of your WordPress website.

Action Example

Let's say we want to log every post indexing task.

<?php

function mb_log_posts_index_updated( $post ) {
    $log = print_r( $post->to_array(), true );
    file_put_contents( '../mb_logs.txt', $log, FILE_APPEND );
}

add_action( 'algolia_posts_index_post_updated', 'mb_log_post_index_updated' );

Note that an action does not need to return anything. If it does, it will be ignored anyway.

In this example, we would log an array representation of the post that has been re-indexed.