Form Buttons

Every Form defaults to rendering 2 buttons for submission (one at top and one at the bottom of the form). You can customize them completely though using the Button object.

Usage

To add custom buttons to your Form:

$form = ee('CP/Form');
$button = $form->getButton('button_1');
$button->setType('submit')->setText('Submit Button')
    ->setWorking('Submitting...');

API Reference

class ExpressionEngine\Library\Cp\Form\Button

getName()

Returns the name used upon creation for the Button and the id.

toArray()

Returns the entire Cp\Form\Button object into an array.

setShortcut($shortcut)

Sets the data-shortcut attribute on the Button

getShortcut()

Returns the data-shortcut attribute on the Button

setAttrs($attrs)

Any custom input parameters you want to attach to your button (attrs).

getAttrs()

Returns the attributes string (attrs)

setType($type)

The type of button to render. Either button, reset, or submit; defaults to button. (type).

getType()

Returns the button type (type)

setValue($value)

The value to use for the “value” parameter (value).

getValue()

The value to use on the Field (value)

setClass($class)

The class property to apply to the Button (class).

getClass()

Returns the class property (class)

setText($text)

A language file compatible key to render a single line of text for your Button (text).

getText()

Returns the set value (text)

setHtml($html)

A raw HTML string placed within the Button (html).

getHtml()

Returns the set value (text)

setWorking($working)

A language compatible string used when button is pressed (html).

getWorking()

Returns the set value (text)

---

ExpressionEngine 6 Docs
©2002–2024 Packet Tide,LLC. Edit this page