PHPackages                             devgeniem/redipress - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Caching](/categories/caching)
4. /
5. devgeniem/redipress

ActiveWordpress-plugin[Caching](/categories/caching)

devgeniem/redipress
===================

RediPress

2.0.17(6mo ago)3432.6k—8.3%6[14 issues](https://github.com/devgeniem/redipress/issues)[12 PRs](https://github.com/devgeniem/redipress/pulls)GPL-3.0-or-laterPHPPHP >=7.3CI passing

Since Mar 16Pushed 4mo ago23 watchersCompare

[ Source](https://github.com/devgeniem/redipress)[ Packagist](https://packagist.org/packages/devgeniem/redipress)[ RSS](/packages/devgeniem-redipress/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (8)Versions (190)Used By (0)

RediPress
=========

[](#redipress)

A WordPress plugin that provides a blazing fast search engine and WP Query performance enhancements.

RediPress utilizes popular in-memory key-value database Redis as well as its RediSearch module, which provides a very performant full text search engine and secondary index on top of Redis.

The plugin hooks to various WordPress APIs, hooks and filters to create a replica of WordPress' posts database table in RediSearch and to keep it up-to-date. It also hooks into `WP_Query` and diverts all suitable queries into RediSearch instead of MySQL, which makes the queries a lot faster, in many cases almost instant.

RediPress also provides advanced searching features that are lacking from the original WordPress search, like weighted search terms and fuzzy search.

RediPress is also built with extensive amount of hooks and filters to customize its functionalities to suit the needs of the developer. In addition to just optimizing the queries, RediPress also brings some completely new features to the table with the ability to include non-WordPress-posts in the search results or adding and querying location data within the index.

Table of Contents
=================

[](#table-of-contents)

- [RediPress](#redipress)
- [Table of Contents](#table-of-contents)
    - [Requirements](#requirements)
    - [Installation and initialization](#installation-and-initialization)
        - [Indexing multisite installations](#indexing-multisite-installations)
    - [Usage](#usage)
        - [Extra parameters](#extra-parameters)
            - [Geolocation](#geolocation)
                - [Sorting](#sorting)
            - [Weights](#weights)
                - [Post types](#post-types)
                - [Authors](#authors)
                - [Taxonomy terms](#taxonomy-terms)
                - [Meta values](#meta-values)
            - [Fuzzy matching](#fuzzy-matching)
            - [Multisite search](#multisite-search)
        - [Filters](#filters)
            - [Query parts](#query-parts)
    - [Expanding](#expanding)
        - [Adding custom fields](#adding-custom-fields)
        - [Modifying the post object](#modifying-the-post-object)
    - [Third party plugins](#third-party-plugins)
        - [Advanced Custom Fields](#advanced-custom-fields)
        - [Polylang](#polylang)
    - [Troubleshooting](#troubleshooting)
    - [WP-CLI](#wp-cli)
        - [command: wp redipress delete](#command-wp-redipress-delete)

Requirements
------------

[](#requirements)

- Redis + [RediSearch](https://oss.redislabs.com/redisearch/index.html) module. At least version 2.2.1 of RediSearch is required. The plugin is tested up to version 2.6.8.
- WordPress version 5.9.0 or later. The plugin could work with earlier versions as well, but it has not been tested.

Installation and initialization
-------------------------------

[](#installation-and-initialization)

1. Install Redis with RediSearch and ensure it can be connected from the WordPress installation.
2. Install and activate the RediPress plugin. For now the only available installation method is through Composer.
3. Define the connection parameters either in the admin panel or as constants in your code (recommended).
4. If you are planning to include custom posts or additional fields in the search index, it should be done now.
5. Create the index schema to RediSearch. It can be done either in the admin panel or through WP-CLI with command `wp redipress create posts`.
6. Run the actual indexing. It can as well be done either in the admin panel or through WP-CLI. Running the command `wp redipress index posts` is a recommended way to run the initial indexing. If the indexing stops you can continue indexing by running the command `wp redipress index posts missing`.

### Indexing multisite installations

[](#indexing-multisite-installations)

You can use the same commands with multisite: `wp redipress create posts` and `wp redipress index posts`. For multisite you have to specify site url with the `--url` parameter in order for RediPress to function properly. Example `wp redipress index --url=subsite.domain.test`.

Usage
-----

[](#usage)

The basic usage of RediPress goes through the `WP_Query` class. You can use the class and functions that depend on it (such as `get_posts()`) like you normally would, and RediPress hooks into the queries and runs them against the RediSearch database instead of the normal MySQL resulting in much lower latencies and query times.

Unlike some other similar query-speeding plugins, you don't need to add any parameters to the queries as RediPress knows what it is capable of doing and handles all queries automatically. If there is a query it can't handle, it automatically falls back to MySQL.

### Extra parameters

[](#extra-parameters)

There are some extra parameters that can be used alongside the regular parameters.

#### Geolocation

[](#geolocation)

If you have defined geolocation fields for your index, you can query them easily with `WP_Query`. The query should be placed on the root level of the `WP_Query` arguments array, and look like this:

```
'geolocation'    => [
    'field'    => 'location',
    'compare'  => ' 'any',
    'orderby'   => 'relevance',
    'weight'    => [
        'post_type' => [
            'post'             => 1.5,
            'page'             => 3.0,
            'custom_post_type' => 7.0,
        ],
    ],
]);
```

##### Authors

[](#authors)

You can also weigh different post authors differently. So far there is no admin functionality for this and it must be done in code.

```
new WP_Query([
    'post_type' => 'any',
    'orderby'   => 'relevance',
    'weight'    => [
        'author' => [
            'admin'      => 1.5,
            'jane_doe'   => 2.0,
            'john_smith' => 5.0,
        ],
    ],
]);
```

##### Taxonomy terms

[](#taxonomy-terms)

It is also possible to weigh posts with certain taxonomy terms higher than others. In this case the first level inside the `taxonomy` parameter is the taxonomy name with another associative array as its value with term slugs and their weights as key-value pairs.

```
new WP_Query([
    'post_type' => 'any',
    'orderby'   => 'relevance',
    'weight'    => [
        'taxonomy' => [
            'category' => [
                'news'          => 3.0,
                'announcements' => 5.0,
            ],
            'post_tag' => [
                'some_tag'    => 4.25,
                'another_tag' => 6.0,
            ],
        ],
    ],
]);
```

##### Meta values

[](#meta-values)

Weights can also be defined for meta values. Obviously the meta keys should be added to the RediPress index and also set to be `queryable`. In this case the first level inside the `meta` is the meta key with another associative array as its value with values and their weights as key-value pairs.

```
new WP_Query([
    'post_type' => 'any',
    'orderby'   => 'relevance',
    'weight'    => [
        'meta' => [
            'meta_key1' => [
                'foo' => 2.0,
                'bar' => 3.0,
            ],
            'another_key' => [
                'fizz' => 1.25,
                'buzz' => 3.0,
            ],
        ],
    ],
]);
```

#### Fuzzy matching

[](#fuzzy-matching)

RediPress supports fuzzy matching of search terms with the `s` parameter. The setting for the Levenshtein distance can be either `1`, `2` or `3`. This can also be set in the admin panel.

```
new WP_Query([
    's'         => 'foobar',
    'post_type' => 'any',
    'fuzzy'     => 2,
]);
```

#### Multisite search

[](#multisite-search)

RediPress supports searching from multiple sites with one query by using special `blog` query parameter. Set site IDs in an array to specify which sites should be targeted. You can use string `'all'` to search all sites, or omit the value to search only current site (default).

```
new WP_Query([
    's'         => 'foobar',
    'post_type' => 'any',
    'blog'      => [ get_main_site_id(), 2, 3 ],
]);
```

By default RediPress does not include the blog ID within the result objects, but you can add it by using `redipress/return_fields` filter.

```
add_filter(
    'redipress/return_fields',
    function ( $return_fields ) {
        $return_fields[] = 'blog_id';

        return $return_fields;
    }
);
```

After that you can use the `blog_id` f. ex. in `redipress/formatted_search_results` filter.

```
add_filter(
    'redipress/formatted_search_results',
    function ( $results, $raw_results ) {

        // Format the raw results into associative array.
        $formatted_raw_results = array_map( function ( $result ) {
            return \Geniem\RediPress\Utility::format( $result );
        }, $raw_results );

        foreach ( $results as $key => $result ) {
            $raw             = $formatted_raw_results[ $key ] ?? [];
            $result->blog_id = (int) $raw['blog_id'] ?? 0;
        }

        return $results;
    },
    10,
    2,
);
```

### Filters

[](#filters)

#### Query parts

[](#query-parts)

To customize the RediSearch query, you can filter individual query parts with the following filters:

- `redipress/sortby`
- `redipress/applies`
- `redipress/filters`
- `redipress/groupby`
- `redipress/reduce_functions`
- `redipress/load`

Expanding
---------

[](#expanding)

RediPress is built to be as developer-friendly as possible. Nearly everything can be filtered and there are a lot of actions to work with.

### Adding custom fields

[](#adding-custom-fields)

To add custom fields into the RediPress index, two things must be done: register a new field into the table schema, and add a filter which provides the data for the field during the indexing and on post save.

Adding a new schema field works with the `redipress/index/posts/schema_fields` filter. (And similarly with the `redipress/index/users/schema_fields` filter) It filters an array of objects that extend `Geniem\RediPress\Entity\SchemaField`. For now the options are a numeric field, a text field a and tag field. The differences on these can be read from the [official RediSearch documentation](https://oss.redislabs.com/redisearch/Commands.html#Parameters).

```
add_filter( 'redipress/index/posts/schema_fields', function( $fields ) {
    $fields[] = new \Geniem\RediPress\Entity\TextField([
        'name'     => 'my_field_name',
        'weight'   => 1.5,
        'sortable' => true,
    ]);

    return $fields;
}, 10, 1 );
```

**Notice** The index needs to be re-created if new fields are created. This happens with the `wp redipress drop posts` command, which - unlike the 1.x versions - does not empty the index but rather drops only the schema which can then be re-created using the `create` command.

When the custom field is created and in the schema, the next is step to provide a function that populates the data for the field. This is done via the `redipress/additional_field/{field_name}` filter. The filter gets called every time the post is indexed, regardless of whether it is done on save post action, on a complete re-index or for example via WP-CLI command.

```
add_filter( 'redipress/additional_field/my_field_name', function( $data, $post_id, $post ) {
    return get_post_meta( $post_id, 'my_field_name', true );
}, 10, 1 );
```

### Modifying the post object

[](#modifying-the-post-object)

RediPress stores the post object serialized in its index. It can be modified before saving which allows the developer to store additional data for the post to be used after it's retrieved from the database.

This happens with the `redipress/post_object` filter. In the example below, all ACF fields of the post are included in the object.

```
add_filter( 'redipress/post_object', function( $post ) {
    $post->fields = \get_fields( $post->ID );

    return $post;
}, 10, 1 );
```

Third party plugins
-------------------

[](#third-party-plugins)

### Advanced Custom Fields

[](#advanced-custom-fields)

There is a lot of functionality in [ACF Codifier](https://github.com/devgeniem/acf-codifier) for working with RediPress. Without Codifier, ACF fields should be included in the index via filters.

### Polylang

[](#polylang)

RediPress supports Polylang out of the box. Other multi-language plugins may require some coding to work.

Troubleshooting
---------------

[](#troubleshooting)

If you run into problems you can try dropping all indexes by running `wp redipress drop posts`. You can also delete all posts adding `--delete-data` flag for the command. After this re-index.

WP-CLI
------

[](#wp-cli)

### command: wp redipress delete

[](#command-wp-redipress-delete)

Delete posts from the index by the arguments.

Arguments:

- `document field:` Any field from the document that should match the given value.
- `limit:` If not defined the default value is 100.

**Note**: the third argument (`posts` in the example) should be the direct *name* of the index, not the type of index (`posts` or `users`). So check your admin configuration or `REDIPRESS_POSTS_INDEX` constant and use that value directly.

Example usage:

```
wp redipress delete posts --blog_id=1 --post_type=article --limit=500
```

###  Health Score

53

—

FairBetter than 97% of packages

Maintenance64

Regular maintenance activity

Popularity39

Limited adoption so far

Community23

Small or concentrated contributor base

Maturity74

Established project with proven stability

 Bus Factor3

3 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~32 days

Recently: every ~89 days

Total

76

Last Release

204d ago

Major Versions

0.0.12 → v1.0.x-dev2019-09-18

0.2.0 → 1.0.02020-01-31

1.16.0 → 2.0.x-dev2023-01-13

1.16.2 → 2.0.32023-02-02

v1.x-dev → 2.0.52023-02-15

PHP version history (3 changes)0.1.0PHP ^7.1

1.14.0PHP >=7.3

1.16.1PHP >=8.0

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/11960000?v=4)[Hion Digital Oy](/maintainers/devgeniem)[@devgeniem](https://github.com/devgeniem)

---

Top Contributors

[![Liblastic](https://avatars.githubusercontent.com/u/8523479?v=4)](https://github.com/Liblastic "Liblastic (30 commits)")[![Nomafin](https://avatars.githubusercontent.com/u/3604893?v=4)](https://github.com/Nomafin "Nomafin (20 commits)")[![HPiirainen](https://avatars.githubusercontent.com/u/5830146?v=4)](https://github.com/HPiirainen "HPiirainen (17 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (14 commits)")[![godbone](https://avatars.githubusercontent.com/u/17048560?v=4)](https://github.com/godbone "godbone (13 commits)")[![samiharju](https://avatars.githubusercontent.com/u/45200156?v=4)](https://github.com/samiharju "samiharju (9 commits)")[![visahakkarainen](https://avatars.githubusercontent.com/u/32507711?v=4)](https://github.com/visahakkarainen "visahakkarainen (7 commits)")[![mpaasto](https://avatars.githubusercontent.com/u/2477630?v=4)](https://github.com/mpaasto "mpaasto (3 commits)")[![tim0haapala](https://avatars.githubusercontent.com/u/93242731?v=4)](https://github.com/tim0haapala "tim0haapala (3 commits)")[![vloy](https://avatars.githubusercontent.com/u/101459373?v=4)](https://github.com/vloy "vloy (1 commits)")[![villepietarinen](https://avatars.githubusercontent.com/u/5517842?v=4)](https://github.com/villepietarinen "villepietarinen (1 commits)")[![jmaekki](https://avatars.githubusercontent.com/u/25431014?v=4)](https://github.com/jmaekki "jmaekki (1 commits)")

---

Tags

wordpressredisredisearch

###  Code Quality

Static AnalysisPHPStan

Type Coverage Yes

### Embed Badge

![Health badge](/badges/devgeniem-redipress/health.svg)

```
[![Health](https://phpackages.com/badges/devgeniem-redipress/health.svg)](https://phpackages.com/packages/devgeniem-redipress)
```

###  Alternatives

[rhubarbgroup/redis-cache

A persistent object cache backend for WordPress powered by Redis. Supports Predis, PhpRedis, Relay, replication, sentinels, clustering and WP-CLI.

51795.3k1](/packages/rhubarbgroup-redis-cache)[rtcamp/nginx-helper

Cleans nginx's fastcgi/proxy cache or redis-cache whenever a post is edited/published. Also provides cloudflare edge cache purging with Cache-Tags.

23517.0k1](/packages/rtcamp-nginx-helper)[macfja/redisearch

PHP Client for RediSearch

67154.9k1](/packages/macfja-redisearch)[pdffiller/qless-php

PHP Bindings for qless

29113.2k1](/packages/pdffiller-qless-php)[front/redisearch

CMS/Framework agnostic RediSearch client

2011.5k](/packages/front-redisearch)[leocolomb/wp-redis

A persistent cache backend for WordPress powered by Redis.

197.2k](/packages/leocolomb-wp-redis)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)