Conditions

You are viewing documentation for an unreleased version of Craft CMS. Please be aware that some pages, screenshots, and technical reference may still reflect older versions.

The Craft CMS condition builder is a powerful tool that helps content editors and site developers utilize dynamic, rule-based settings.

Abstracted illustration of a condition builder with a criteria row and an add button

There are several places you can find the condition builder in action:

  • Conditional field layouts, which make it possible to display specific tabs or fields only when precise criteria are met;
  • Custom sources, which are optional element index sources customized to display whatever elements meet the criteria you set;
  • Search field filters;
  • Craft Commerce’s promotion and shipping rules;

# Architecture

A condition is a group of one or more condition rules that, when combined, can perform a collective task like modifying an element query or matching an element. The rules are available for a control panel user to configure, should they decide to utilize a condition wherever you’ve made it available.

The “condition builder” is the Htmx (opens new window)-powered UI framework the control panel user interacts with in their browser.

Custom fields may define condition rule types to be pulled into element conditions. Most built-in field types take advantage of this and are a great source of examples.

Element types also have an opportunity to register their own conditions and condition rules for native attribute types.

At a high level, a condition rule doesn’t know anything about how it will be used. The craft\base\conditions\BaseCondition (opens new window) class does most of the work to stitch things together and construct the appropriate UI. This base condition class is extended by most of Craft’s included conditions, and all of these pieces are integral parts of the condition builder framework.

# Condition Builder Framework

Developers can work with existing conditions or introduce new ones using the condition builder framework.

Conditions need to implement ConditionInterface (opens new window). A generic base implementation is provided by BaseCondition (opens new window).

Condition rules must implement ConditionRuleInterface (opens new window). You’ll find a generic BaseConditionRule (opens new window) implementation along with a handful of base condition rules in base/conditions/ that are geared for common rule formats.

The HTML representation of a condition builder can be generated with $condition->getBuilderHtml(), which supports a few builder-specific options:

  • mainTag – The container tag type (form, by default);
  • id – The HTML container’s id attribute;
  • sortable – Whether the rules should be user-sortable (true by default);
  • singleUseTypes – Whether rules can only be used once within the condition;
  • projectConfigTypes – Whether to limit the available rules to those which can be stored in the project config (needed for custom sources);

# Element Query Conditions

Element types can provide their own custom condition classes which extend ElementCondition (opens new window). Doing so will give them a chance to include additional element type-specific rules, by overriding conditionRuleTypes() (opens new window) (see EntryCondition (opens new window) for an example).

The element type should return an instance of its custom condition class from a static createCondition() method.

# Field Condition Rules

Field types can provide a rule type which implements FieldConditionRuleInterface (opens new window) and uses FieldConditionRuleTrait (opens new window).