This document contains information for an outdated version (3.1) and may not be maintained any more. If some of your projects still use this version, consider upgrading as soon as possible.
How to Show Help Text on CMS Form Fields
Sometimes you need to express more context for a form field
than is suitable for its
The CMS provides you with an easy way to transform
form field attributes into either help text
shown alongside the field, or a tooltip which shows on demand.
FormField->setDescription() method will add a
at the last position within the field, and expects unescaped HTML content.
TextField::create('MyText', 'My Text Label') ->setDescription('More <strong>detailed</strong> help');
To show the help text as a tooltip instead of inline,
TextField::create('MyText', 'My Text Label') ->setDescription('More <strong>detailed</strong> help') ->addExtraClass('cms-description-tooltip');
Tooltips are only supported
for native, focusable input elements, which excludes
more complex fields like
DropdownField with the chosen.js behaviour applied.
Note: For more advanced help text we recommend using Custom form field templates;