2026.10.4
Home ▸ Template functions

Test if undefined: undefined

The undefined test checks whether a variable has not been defined in the current template context. It returns true if the variable does not exist and false if it has been assigned a value. It is the opposite of defined.

This is useful when you want to explicitly detect missing variables and handle the absence case. For instance, you might want to set a default value or skip a section of the template when a particular variable has not been provided. While default is often more concise for fallback values, undefined gives you full control with {% if %} blocks.

Usage

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

As a test 
{% if my_variable is undefined %}
  Variable is missing
{% endif %}
Result (stringA piece of text, like a name, message, or entity ID. In templates, wrap strings in quotes, like "living_room" or "lights are on".) 
Variable is missing

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 = are usually required. A few optional parameters have no default value, so the signature shows them without a = as well. To check whether a parameter is required, look at the parameter list below the signature. Each parameter is marked as Required or Optional.

The most common optional parameter without a default value is default. The default parameter sets the value a function returns when the function can’t produce a result, for example, when float gets text that isn’t a number. If you leave out default, there is no fallback value, so most functions raise an error and the template fails. The parameter list of each function says what happens. If you set default, the function returns your value instead.

How to read a signature

Here is the signature of the round filter as an example:

round(
    value: Any,
    precision: int = 0,
    method: str = "common",
    default: Any,
) -> float | int | Any
  • round is the name of the function.
  • Between the parentheses are the parameters. Each parameter has a name, followed by a colon and the type of value the parameter expects. The type only tells you what kind of value to pass. For default: Any, you pass a value of any type, such as 0 or "unknown", not the word Any.
  • = 0 and = "common" are default values. You can leave out precision and method, and round uses these default values.
  • default has no =, but the parameter list marks default as optional. If you leave out default and round gets a value that isn’t a number, round raises an error.
  • -> shows the type of value the function returns.
  • Inside a signature, | means “or”. This function returns a decimal number, a whole number, or the value you passed as default.

round is a filter, so the first parameter, value, is the value before the |. For example, {{ 3.14159 | round(2) }} returns 3.14.

The types you’ll see most often:

  • str: text, such as "hello"
  • int: a whole number, such as 5
  • float: a decimal number, such as 3.14
  • bool: true or false
  • list: a list of values, such as [1, 2, 3]. list[str] is a list of texts.
  • dict: a set of keys and values, such as {"name": "Kitchen"}
  • datetime and timedelta: a date and time, and a duration. For details, refer to Dates and times.
  • None: no value
  • Any: any type of value

Some signatures use special forms:

  • *args means you can pass any number of values, separated by commas. For example, average(1, 2, 3).
  • value | name(...) means the function is a filter. The value before the | is passed to the filter as its first parameter. Some filter signatures, like the round example, show this value as the first parameter between the parentheses instead.
undefined(
    value: Any,
) -> bool

Function parameters

The following parameters can be provided to this test.

value any Required

The variable to test. Returns true if the variable is not defined in the current context.

Good to know

  • A variable explicitly set to none is still defined, so this test returns false for it. Use is none to check for that case.
  • Useful for template macros or scripts where callers may or may not pass an argument.

Try it yourself

Ready to test this? Open Settings > 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.

Provide fallback logic for missing data

When an optional variable is not provided, supply alternative content.

TemplateA template is an automation definition that can include variables for the action or data from the trigger values. This allows automations to generate dynamic actions. [Learn more] 
{% if custom_greeting is undefined %}
  Welcome home!
{% else %}
  {{ custom_greeting }}
{% endif %}
Result (stringA piece of text, like a name, message, or entity ID. In templates, wrap strings in quotes, like "living_room" or "lights are on".) 
Welcome home!

Skip optional sections

Only render a section when the required data is available.

TemplateA template is an automation definition that can include variables for the action or data from the trigger values. This allows automations to generate dynamic actions. [Learn more] 
Status report:
{% if details is undefined %}
  No additional details available.
{% else %}
  {{ details }}
{% endif %}
Result (stringA piece of text, like a name, message, or entity ID. In templates, wrap strings in quotes, like "living_room" or "lights are on".) 
Status report:
  No additional details available.

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.

Tip

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: