Cp

Type

Class

Namespace

craft\helpers

Inherits

craft\helpers\Cp

Since

3.0.0

Class Cp

View source

Public Methods

Method	Description
alerts()
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.
dateTimeFieldHtml()	Renders a date + time field’s HTML.
editElementTitles()	Returns the page title and document title that should be used for Edit Element pages.
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.
fieldHtml()	Renders a field’s HTML, for the given input HTML or a template.
lightswitchFieldHtml()	Renders a lightswitch field’s HTML.
metadataHtml()	Returns a metadata component’s HTML.
renderTemplate()	Renders a control panel template.
selectFieldHtml()	Renders a select field’s HTML.
selectHtml()	Renders a select input.
textFieldHtml()	Renders a text field’s HTML.
textareaFieldHtml()	Renders a textarea field’s HTML.

alerts()

View source

Arguments

• $path (string, null)
• $fetch (boolean)

Returns

array

autosuggestFieldHtml()

Since

3.7.0

Renders an autosuggest field’s HTML.

View source

Arguments

• $config (array)

Returns

string

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'].

View source

Arguments

• $config (array)

Returns

string

Throws

• yii\base\InvalidArgumentException
  if $config['siteId'] is invalid

checkboxSelectFieldHtml()

Since

3.6.0

Renders a checkbox select field’s HTML.

View source

Arguments

• $config (array)

Returns

string

Throws

• yii\base\InvalidArgumentException
  if $config['siteId'] is invalid

colorFieldHtml()

Since

3.6.0

Renders a color field’s HTML.

View source

Arguments

• $config (array)

Returns

string

Throws

• yii\base\InvalidArgumentException
  if $config['siteId'] is invalid

dateTimeFieldHtml()

Since

3.7.0

Renders a date + time field’s HTML.

View source

Arguments

• $config (array)

Returns

string

Throws

• yii\base\InvalidArgumentException
  if $config['siteId'] is invalid

editElementTitles()

Since

3.7.0

Returns the page title and document title that should be used for Edit Element pages.

View source

Arguments

• $element (craft\base\ElementInterface)

Returns

string[]

editableTableFieldHtml()

Since

3.6.0

Renders an editable table field’s HTML.

View source

Arguments

• $config (array)

Returns

string

Throws

• yii\base\InvalidArgumentException
  if $config['siteId'] is invalid

elementHtml()

Since

3.5.8

Renders an element’s HTML.

View source

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 (small or large)
• $inputName (string, null) – The name attribute that should be set on the hidden input, if $context is set to field
• $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 []

Returns

string

elementPreviewHtml()

Since

3.6.3

Returns element preview HTML, for a list of elements.

View source

Arguments

• $elements (craft\base\ElementInterface[]) – The elements
• $size (string) – The size of the element (small or large)
• $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

string

elementSelectFieldHtml()

Since

3.7.0

Renders an element select field’s HTML.

View source

Arguments

• $config (array)

Returns

string

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.

View source

Arguments

• $input (string) – The input HTML or template path. If passing a template path, it must begin with template:.
• $config (array)

Returns

string

Throws

• craft\web\twig\TemplateLoaderException
  if $input begins with template: and is followed by an invalid template path
• yii\base\InvalidArgumentException
  if $config['siteId'] is invalid

lightswitchFieldHtml()

Since

3.6.0

Renders a lightswitch field’s HTML.

View source

Arguments

• $config (array)

Returns

string

Throws

• yii\base\InvalidArgumentException
  if $config['siteId'] is invalid

metadataHtml()

Returns a metadata component’s HTML.

View source

Arguments

• $data (array) – The data, with keys representing the labels. The values can either be strings or callables. If a value is false, it will be omitted.

Returns

string

renderTemplate()

Renders a control panel template.

View source

Arguments

• $template (string)
• $variables (array)

Returns

string

Throws

• craft\web\twig\TemplateLoaderException
  if $template is an invalid template path

selectFieldHtml()

Since

3.6.0

Renders a select field’s HTML.

View source

Arguments

• $config (array)

Returns

string

Throws

• yii\base\InvalidArgumentException
  if $config['siteId'] is invalid

selectHtml()

Since

3.6.0

Renders a select input.

View source

Arguments

• $config (array)

Returns

string

textFieldHtml()

Since

3.6.0

Renders a text field’s HTML.

View source

Arguments

• $config (array)

Returns

string

Throws

• yii\base\InvalidArgumentException
  if $config['siteId'] is invalid

textareaFieldHtml()

Since

3.6.0

Renders a textarea field’s HTML.

View source

Arguments

• $config (array)

Returns

string

Throws

• yii\base\InvalidArgumentException
  if $config['siteId'] is invalid

Constants

Constant	Description
ELEMENT_SIZE_LARGE
ELEMENT_SIZE_SMALL

Events

EVENT_REGISTER_ALERTS

Type

craft\events\RegisterCpAlertsEvent

The event that is triggered when registering control panel alerts.

---