Test if string contains pattern: search

The search template test checks whether a string contains a regular expression (regex) pattern anywhere within it. A regular expression is a special text pattern that lets you describe what you are looking for, such as “any number” or “the word offline”. As a template test, it is used with the is keyword, making your templates read like natural language.

This is useful in conditions and {% if %} blocks where you want to check if a value contains a certain pattern. For example, you might test whether a sensor’s state contains the word “error”, whether a notification message includes a phone number, or whether a device attribute mentions a particular model. Unlike the match test, which only checks the beginning of the string, search scans the entire string for the pattern.

Usage

Here’s how to use this template function. Copy any example and adjust it to your setup.

{% if "Temperature is 23.5 degrees" is search("\\d+\\.\\d+") %}
  Contains a decimal number
{% endif %}

Contains a decimal number

Function signature

The signature is a technical summary of this template function. It shows the name of the function, the values (called parameters) it accepts, and what type of data each parameter expects (for example, a piece of text or a number).

Function parameters that have a = with a value after them are optional. If you leave them out, the default value shown is used automatically. Function parameters without a default are required.

search(
    value: str,
    find: str = "",
    ignorecase: bool = False,
) -> bool

Function parameters

The following parameters can be provided to this function.

Good to know

• Returns true or false only. Use regex_findall to get the matched substrings.
• Case-sensitive by default. Pass ignorecase=true to match regardless of case.

Try it yourself

Ready to test this? Open Developer tools > Template, paste the example into the Template editor, and watch the result update on the right. Edit the values to see how the function adapts to your own entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more].

More examples

Real scenarios where this function comes up in automations and templates. Copy any example and adapt it to your setup.

Check if a state contains a keyword

Test whether a sensor’s state text contains a specific word, regardless of case.

{% if states("sensor.system_status") is search("offline", ignorecase=true) %}
  System is offline!
{% endif %}

System is offline!

Filter entities with a pattern in their state

Use the search test to find entities whose state contains a particular pattern.

{% for entity in states.sensor
  if entity.state is search("error|fault|fail", ignorecase=true) %}
  {{ entity.entity_id }}: {{ entity.state }}
{% endfor %}

Check for a numeric value in text

Test whether a text-based sensor state includes any number.

{% if states("sensor.status_message") is search("\\d+") %}
  Status contains a number
{% else %}
  Status is text only
{% endif %}

Status contains a number

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with your template and expected result, or share on our subreddit /r/homeassistant.

Related template functions

These functions work well alongside this one:

• Test if string matches pattern: match - Template test that checks if a string matches a regular expression at the beginning.

• Search for a regex pattern: regex_search - Searches for a regular expression pattern anywhere in a string.

• Match a regex pattern: regex_match - Tests if a string matches a regular expression pattern at the beginning.