Strip HTML tags: striptags
The striptags filter removes all HTML and XML tags from a string, leaving only the plain text content. It also normalizes whitespace by collapsing multiple spaces into one and trimming the result.
This is useful when you receive HTML-formatted content from a sensorSensors return information about a thing, for instance the level of water in a tank. [Learn more] or external source and need only the plain text. For example, some weather services or RSS feed sensorsSensors return information about a thing, for instance the level of water in a tank. [Learn more] provide descriptions with HTML markup, and you might want to strip the tags before displaying the content in a notification or on a dashboard card.
Usage
Here’s how to use this template function. Copy any example and adjust it to your setup.
{{ "<p>Hello <b>World</b></p>" | striptags }}
Hello World
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.
striptags(
value: str,
) -> str
Function parameters
The following parameters can be provided to this function.
Good to know
- Whitespace is normalized: runs of spaces, tabs, and newlines are collapsed into single spaces, and the result is trimmed.
- Only tags are removed. HTML entities like
&or remain as-is. Combine withreplaceif you need to decode them.
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.
Extract plain text from an HTML sensor
Strip HTML from a sensor that provides formatted content.
{{ states.sensor.news_headline.attributes.description | striptags }}
Breaking news: severe weather warning issued for the area.
Clean up HTML content for a notification
Remove HTML tags from a message before sending it as a plain text notification.
{{
"<h1>Alert</h1><p>Motion detected in the <em>backyard</em>.</p>"
| striptags
}}
Alert Motion detected in the backyard.
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.
AI assistants like ChatGPT or Claude can also explain or fix templates when you describe what you want in plain language.
Related template functions
These functions work well alongside this one:
-
Escape HTML characters: escape - Escapes HTML special characters in a string so they display as literal text.
-
Replace occurrences in a string: replace - Replaces all occurrences of a substring with another string.
-
Strip whitespace: trim - Strips leading and trailing whitespace (or specified characters) from a string.