Cp ​
- Type
- Class
- Namespace
- craft\helpers
- Inherits
- craft\helpers\Cp
- Since
- 3.0.0
Class Cp
Public Methods ​
| Method | Description |
|---|---|
| addressCardHtml() | Renders an address card for an Addresses input. |
| addressCardsHtml() | Renders address cards. |
| addressFieldsHtml() | Returns address fields’ HTML (sans country) for a given address. |
| autosuggestFieldHtml() | Renders an autosuggest field’s HTML. |
| checkboxFieldHtml() | Renders a checkbox field’s HTML. |
| checkboxSelectFieldHtml() | Renders a checkbox select field’s HTML. |
| colorFieldHtml() | Renders a color field’s HTML. |
| dateFieldHtml() | Returns a date field’s HTML. |
| dateHtml() | Returns a date input’s HTML. |
| dateTimeFieldHtml() | Renders a date + time field’s HTML. |
| editableTableFieldHtml() | Renders an editable table field’s HTML. |
| elementHtml() | Renders an element’s HTML. |
| elementPreviewHtml() | Returns element preview HTML, for a list of elements. |
| elementSelectFieldHtml() | Renders an element select field’s HTML. |
| elementSelectHtml() | Renders an element select input’s HTML |
| fieldHtml() | Renders a field’s HTML, for the given input HTML or a template. |
| fieldLayoutDesignerHtml() | Renders a field layout designer. |
| lightswitchFieldHtml() | Renders a lightswitch field’s HTML. |
| lightswitchHtml() | Renders a lightswitch input’s HTML. |
| metadataHtml() | Returns a metadata component’s HTML. |
| multiSelectFieldHtml() | Renders a multi-select field’s HTML. |
| multiSelectHtml() | Renders a multi-select input. |
| renderTemplate() | Renders a control panel template. |
| requestedSite() | Returns the site the control panel is currently working with, via a site query string param if sent. |
| selectFieldHtml() | Renders a select field’s HTML. |
| selectHtml() | Renders a select input. |
| selectizeFieldHtml() | Renders a selectize field’s HTML. |
| selectizeHtml() | Renders a selectize input. |
| textFieldHtml() | Renders a text field’s HTML. |
| textHtml() | Renders a text input’s HTML. |
| textareaFieldHtml() | Renders a textarea field’s HTML. |
| textareaHtml() | Renders a textarea input’s HTML. |
| timeFieldHtml() | Returns a date field’s HTML. |
| timeHtml() | Returns a time input’s HTML. |
addressCardHtml() ​
- Since
- 4.0.0
Renders an address card for an Addresses input.
Arguments ​
$address(craft\elements\Address)$config(array)
Returns ​
addressCardsHtml() ​
- Since
- 4.0.0
Renders address cards.
Arguments ​
$addresses(craft\elements\Address[])$config(array)
Returns ​
addressFieldsHtml() ​
- Since
- 4.0.0
Returns address fields’ HTML (sans country) for a given address.
Arguments ​
$address(craft\elements\Address)
Returns ​
autosuggestFieldHtml() ​
- Since
- 3.7.0
Renders an autosuggest field’s HTML.
Arguments ​
$config(array)
Returns ​
Throws ​
- yii\base\InvalidArgumentException
if$config['siteId']is invalid
checkboxFieldHtml() ​
- Since
- 3.6.0
Renders a checkbox field’s HTML.
Note that unlike the checkboxField macro in _includes/forms.html, you must set the checkbox label via $config['checkboxLabel'].
Arguments ​
$config(array)
Returns ​
Throws ​
- yii\base\InvalidArgumentException
if$config['siteId']is invalid
checkboxSelectFieldHtml() ​
- Since
- 3.6.0
Renders a checkbox select field’s HTML.
Arguments ​
$config(array)
Returns ​
Throws ​
- yii\base\InvalidArgumentException
if$config['siteId']is invalid
colorFieldHtml() ​
- Since
- 3.6.0
Renders a color field’s HTML.
Arguments ​
$config(array)
Returns ​
Throws ​
- yii\base\InvalidArgumentException
if$config['siteId']is invalid
dateFieldHtml() ​
- Since
- 4.0.0
Returns a date field’s HTML.
Arguments ​
$config(array)
Returns ​
Throws ​
- yii\base\InvalidArgumentException
if$config['siteId']is invalid
dateHtml() ​
- Since
- 4.0.0
Returns a date input’s HTML.
Arguments ​
$config(array)
Returns ​
Throws ​
- yii\base\InvalidArgumentException
if$config['siteId']is invalid
dateTimeFieldHtml() ​
- Since
- 3.7.0
Renders a date + time field’s HTML.
Arguments ​
$config(array)
Returns ​
Throws ​
- yii\base\InvalidArgumentException
if$config['siteId']is invalid
editableTableFieldHtml() ​
- Since
- 3.6.0
Renders an editable table field’s HTML.
Arguments ​
$config(array)
Returns ​
Throws ​
- yii\base\InvalidArgumentException
if$config['siteId']is invalid
elementHtml() ​
- Since
- 3.5.8
Renders an element’s HTML.
Arguments ​
$element(craft\base\ElementInterface) – The element to be rendered$context(string) – The context the element is going to be shown in (index,field, etc.)$size(string) – The size of the element (smallorlarge)$inputName(string, null) – Thenameattribute that should be set on the hidden input, if$contextis set tofield$showStatus(boolean) – Whether the element status should be shown (if the element type has statuses)$showThumb(boolean) – Whether the element thumb should be shown (if the element has one)$showLabel(boolean) – Whether the element label should be shown$showDraftName(boolean) – Whether to show the draft name beside the label if the element is a draft of a published element$single(boolean) – Whether the input name should omit the trailing[]$autoReload(boolean) – Whether the element should auto-reload itself when it’s saved
Returns ​
elementPreviewHtml() ​
- Since
- 3.6.3
Returns element preview HTML, for a list of elements.
Arguments ​
$elements(craft\base\ElementInterface[]) – The elements$size(string) – The size of the element (smallorlarge)$showStatus(boolean) – Whether the element status should be shown (if the element type has statuses)$showThumb(boolean) – Whether the element thumb should be shown (if the element has one)$showLabel(boolean) – Whether the element label should be shown$showDraftName(boolean) – Whether to show the draft name beside the label if the element is a draft of a published element
Returns ​
elementSelectFieldHtml() ​
- Since
- 3.7.0
Renders an element select field’s HTML.
Arguments ​
$config(array)
Returns ​
Throws ​
- yii\base\InvalidArgumentException
if$config['siteId']is invalid
elementSelectHtml() ​
- Since
- 4.0.0
Renders an element select input’s HTML
Arguments ​
$config(array)
Returns ​
Throws ​
- yii\base\InvalidArgumentException
if$config['siteId']is invalid
fieldHtml() ​
- Since
- 3.5.8
Renders a field’s HTML, for the given input HTML or a template.
Arguments ​
$input(string) – The input HTML or template path. If passing a template path, it must begin withtemplate:.$config(array)
Returns ​
Throws ​
- craft\web\twig\TemplateLoaderException
if $input begins withtemplate:and is followed by an invalid template path - yii\base\InvalidArgumentException
if$config['siteId']is invalid
fieldLayoutDesignerHtml() ​
- Since
- 4.0.0
Renders a field layout designer.
Arguments ​
$fieldLayout(craft\models\FieldLayout)$config(array)
Returns ​
lightswitchFieldHtml() ​
- Since
- 3.6.0
Renders a lightswitch field’s HTML.
Arguments ​
$config(array)
Returns ​
Throws ​
- yii\base\InvalidArgumentException
if$config['siteId']is invalid
lightswitchHtml() ​
- Since
- 4.0.0
Renders a lightswitch input’s HTML.
Arguments ​
$config(array)
Returns ​
Throws ​
- yii\base\InvalidArgumentException
if$config['siteId']is invalid
metadataHtml() ​
Returns a metadata component’s HTML.
Arguments ​
$data(array) – The data, with keys representing the labels. The values can either be strings or callables. If a value isfalse, it will be omitted.
Returns ​
multiSelectFieldHtml() ​
- Since
- 4.0.0
Renders a multi-select field’s HTML.
Arguments ​
$config(array)
Returns ​
Throws ​
- yii\base\InvalidArgumentException
if$config['siteId']is invalid
multiSelectHtml() ​
- Since
- 4.0.0
Renders a multi-select input.
Arguments ​
$config(array)
Returns ​
renderTemplate() ​
Renders a control panel template.
Arguments ​
Returns ​
Throws ​
- craft\web\twig\TemplateLoaderException
if$templateis an invalid template path
requestedSite() ​
- Since
- 4.0.0
Returns the site the control panel is currently working with, via a site query string param if sent.
Returns ​
craft\models\Site, null – The site, or null if the user doesn’t have permission to edit any sites.
selectFieldHtml() ​
- Since
- 3.6.0
Renders a select field’s HTML.
Arguments ​
$config(array)
Returns ​
Throws ​
- yii\base\InvalidArgumentException
if$config['siteId']is invalid
selectHtml() ​
- Since
- 3.6.0
Renders a select input.
Arguments ​
$config(array)
Returns ​
selectizeFieldHtml() ​
- Since
- 4.0.0
Renders a selectize field’s HTML.
Arguments ​
$config(array)
Returns ​
Throws ​
- yii\base\InvalidArgumentException
if$config['siteId']is invalid
selectizeHtml() ​
- Since
- 4.0.0
Renders a selectize input.
Arguments ​
$config(array)
Returns ​
textFieldHtml() ​
- Since
- 3.6.0
Renders a text field’s HTML.
Arguments ​
$config(array)
Returns ​
Throws ​
- yii\base\InvalidArgumentException
if$config['siteId']is invalid
textHtml() ​
- Since
- 4.0.0
Renders a text input’s HTML.
Arguments ​
$config(array)
Returns ​
Throws ​
- yii\base\InvalidArgumentException
if$config['siteId']is invalid
textareaFieldHtml() ​
- Since
- 3.6.0
Renders a textarea field’s HTML.
Arguments ​
$config(array)
Returns ​
Throws ​
- yii\base\InvalidArgumentException
if$config['siteId']is invalid
textareaHtml() ​
- Since
- 4.0.0
Renders a textarea input’s HTML.
Arguments ​
$config(array)
Returns ​
Throws ​
- yii\base\InvalidArgumentException
if$config['siteId']is invalid
timeFieldHtml() ​
- Since
- 4.0.0
Returns a date field’s HTML.
Arguments ​
$config(array)
Returns ​
Throws ​
- yii\base\InvalidArgumentException
if$config['siteId']is invalid
timeHtml() ​
- Since
- 4.0.0
Returns a time input’s HTML.
Arguments ​
$config(array)
Returns ​
Throws ​
- yii\base\InvalidArgumentException
if$config['siteId']is invalid
Constants ​
| Constant | Description |
|---|---|
ELEMENT_SIZE_LARGE | |
ELEMENT_SIZE_SMALL |
Events ​
EVENT_DEFINE_ELEMENT_INNER_HTML ​
- Type
- craft\events\DefineElementInnerHtmlEvent
- Since
- 4.0.0
The event that is triggered when defining an element’s inner HTML.
EVENT_REGISTER_ALERTS ​
The event that is triggered when registering control panel alerts.