PHPackages                             sspat/es-query-sanitizer - 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. [Search & Filtering](/categories/search)
4. /
5. sspat/es-query-sanitizer

ActiveLibrary[Search & Filtering](/categories/search)

sspat/es-query-sanitizer
========================

Simple helper class to sanitize ElasticSearch reserved characters from query strings

1.0.2(8y ago)6207.8k↑16.7%1MITPHPPHP >=5.6.0

Since Jan 18Pushed 8y ago1 watchersCompare

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

READMEChangelogDependencies (1)Versions (4)Used By (1)

Simple helper class to sanitize ElasticSearch reserved characters from query strings
====================================================================================

[](#simple-helper-class-to-sanitize-elasticsearch-reserved-characters-from-query-strings)

Inspired by [node-elasticsearch-sanitize](https://github.com/lanetix/node-elasticsearch-sanitize)

[![Author](https://camo.githubusercontent.com/2e7ca2bfc97137f1af3856460dd8d4cc962e84ef4af176cc8d0ff9a22b07dd3d/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f617574686f722d4073737061742d626c75652e7376673f7374796c653d666c61742d737175617265)](https://moikrug.ru/sspat)![GitHub tag](https://camo.githubusercontent.com/74f415cc9feb911a7af954957b15b5ffa2a129f0796028d4455ceaf28db7eb81/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f7461672f73737061742f65732d71756572792d73616e6974697a65722e737667)[![license](https://camo.githubusercontent.com/850eae1099d2b05f53383473d7cd51f9bc1ab09b7d0d9e5122f1dd930efdcc6d/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f6d6173686170652f6170697374617475732e737667)](https://github.com/sspat/es-query-sanitizer/blob/master/LICENSE)

Features
--------

[](#features)

Accepts an arbitrary string as input and escapes the ElasticSearch reserved characters:

`+ - = && || > < ! ( ) { } [ ] ^ " ~ * ? : \ / AND OR NOT space`

Returns a sanitized string which can be safely used in an ElasticSearch query\_string query.

Installation
------------

[](#installation)

The preferred way to install this extension is through [composer](http://getcomposer.org/download/).

Either run

```
composer require sspat/es-query-sanitizer

```

or add

```
"sspat/es-query-sanitizer": "~1.0"

```

to the require section of your `composer.json` file.

Usage
-----

[](#usage)

To use pass in a string:

```
$unescapedQueryString = 'AND there! are? (lots of) char*cters 2 ^escape!'
$escapedQueryString = \sspat\ESQuerySanitizer\Sanitizer::escape($unescapedQueryString);

echo $escapedQueryString; // \A\N\D\ there\!\ are\?\ \(lots\ of\)\ char\*cters\ 2\ \^escape\!
```

You can also pass an array as the second argument, if you want to prevent some characters from being escaped:

```
$unescapedQueryString = 'AND there! are? (lots of) char*cters 2 ^escape!'
$excludeCharacters = ['!', '^'];
$escapedQueryString = \sspat\ESQuerySanitizer\Sanitizer::escape($unescapedQueryString, $excludeCharacters);

echo $escapedQueryString; // \A\N\D\ there!\ are\?\ \(lots\ of\)\ char\*cters\ 2\ ^escape!
```

###  Health Score

36

—

LowBetter than 82% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity38

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity60

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

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 ~4 days

Total

2

Last Release

3038d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/7f762f20ec3d91c4c4c0ae56424e38c8658076ada202c68e1acfde68b5476050?d=identicon)[sspat](/maintainers/sspat)

---

Top Contributors

[![sspat](https://avatars.githubusercontent.com/u/5153242?v=4)](https://github.com/sspat "sspat (7 commits)")

---

Tags

elasticsearchqueryEscapesanitize

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/sspat-es-query-sanitizer/health.svg)

```
[![Health](https://phpackages.com/badges/sspat-es-query-sanitizer/health.svg)](https://phpackages.com/packages/sspat-es-query-sanitizer)
```

###  Alternatives

[elasticsearch/elasticsearch

PHP Client for Elasticsearch

5.3k178.3M943](/packages/elasticsearch-elasticsearch)[netgen/query-translator

Query Translator is a search query translator with AST representation

2042.0M6](/packages/netgen-query-translator)[opensearch-project/opensearch-php

PHP Client for OpenSearch

15224.3M65](/packages/opensearch-project-opensearch-php)[babenkoivan/elastic-scout-driver

Elasticsearch driver for Laravel Scout

2773.8M5](/packages/babenkoivan-elastic-scout-driver)[babenkoivan/elastic-scout-driver-plus

Extension for Elastic Scout Driver

2862.8M1](/packages/babenkoivan-elastic-scout-driver-plus)[jsq/amazon-es-php

Support for using IAM authentication with the official Elasticsearch PHP client

9310.6M13](/packages/jsq-amazon-es-php)

PHPackages © 2026

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