Filters Reference

Introduction

Filters are a way to alter data during the lifecycle of a request. The idea is simple: you listen for a filter to be called by using add_filter, you edit your data and return it modified.

Filter Example

The plugin has a blacklist mechanism to not display certain post types in the admin UI. By default, we disabled the following post types to appear:

• nav_menu_item
• revision
• algolia_task
• algolia_log
• kr_request_token
• kr_access_token
• deprecated_log
• async-scan-result
• scanresult

Let's say that you have a your plugin introducing some custom content types, but these are meant to be used internally and you don't want to expose them for indexing.

<?php

function mb_blacklist_custom_post_type( array $blacklist ) {
    $blacklist[] = 'custom_post_type';

    return $blacklist;
}

add_filter( 'algolia_post_types_blacklist', 'mb_blacklist_custom_post_type' );

Your custom_post_type will no longer appear for indexing in the indexing screen. This will also disable tasks being generated for that content type.

Filters Reference

Here is the list of all available Filters.