Craft 3 Class Reference

Cp

Type
Class
Namespace
craft\web\twig\variables
Inherits
craft\web\twig\variables\Cp » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.0.0

Control panel functions

View source

# Public Properties

Property Description
alerts array
behaviors yii\base\Behavior – List of behaviors attached to this component
envSuggestions string[]
templateSuggestions string[]

# alerts

Type
array
Default value
null
Access
Read-only

View source

# envSuggestions

Type
string[]
Default value
null
Access
Read-only
Since
3.1.0

View source

# templateSuggestions

Type
string[]
Default value
null
Access
Read-only
Since
3.1.0

View source

# Public Methods

Method Description
__call() Calls the named method which is not a class method.
__clone() This method is called after the object is created by cloning an existing one.
__construct() Constructor.
__get() Returns the value of an object property.
__isset() Checks if a property is set, i.e. defined and not null.
__set() Sets value of an object property.
__unset() Sets an object property to null.
areAlertsCached() Returns whether the control panel alerts are cached.
attachBehavior() Attaches a behavior to this component.
attachBehaviors() Attaches a list of behaviors to the component.
behaviors() Returns a list of behaviors that this component should behave as.
canGetProperty() Returns a value indicating whether a property can be read.
canSetProperty() Returns a value indicating whether a property can be set.
className() Returns the fully qualified name of this class.
craftIdAccountUrl() Returns the Craft ID account URL.
detachBehavior() Detaches a behavior from the component.
detachBehaviors() Detaches all behaviors from the component.
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component.
getAlerts() Returns an array of alerts to display in the control panel.
getAsciiCharMap() Returns ASCII character mappings for the given language, if it differs from the application language.
getBehavior() Returns the named behavior object.
getBehaviors() Returns all behaviors attached to this component.
getEnvSuggestions() Returns the available environment variable and alias suggestions for inputs that support them.
getTemplateSuggestions() Returns the available template path suggestions for template inputs.
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event.
hasMethod() Returns a value indicating whether a method is defined.
hasProperty() Returns a value indicating whether a property is defined.
init() Initializes the object.
nav() Returns the control panel nav items.
off() Detaches an existing event handler from this component.
on() Attaches an event handler to an event.
settings() Returns the list of settings.
trigger() Triggers an event.

# areAlertsCached()

Returns whether the control panel alerts are cached.

View source

Returns

boolean

# craftIdAccountUrl()

Returns the Craft ID account URL.

View source

Returns

string

# getAlerts()

Returns an array of alerts to display in the control panel.

View source

Returns

array

# getAsciiCharMap()

Since
3.1.9

Returns ASCII character mappings for the given language, if it differs from the application language.

View source

Arguments

Returns

array, null

# getEnvSuggestions()

Since
3.1.0

Returns the available environment variable and alias suggestions for inputs that support them.

View source

Arguments

  • $includeAliases (boolean) – Whether aliases should be included in the list (only enable this if the setting defines a URL or file path)

Returns

string[]

# getTemplateSuggestions()

Since
3.1.0

Returns the available template path suggestions for template inputs.

View source

Returns

string[]

# nav()

Returns the control panel nav items.

Each control panel nav item should be defined by an array with the following keys:

  • label – The human-facing nav item label
  • url – The URL the nav item should link to
  • id – The HTML id attribute the nav item should have (optional)
  • icon – The path to an SVG file that should be used as the nav item icon (optional)
  • fontIcon – A character/ligature from Craft’s font icon set (optional)
  • badgeCount – A number that should be displayed beside the nav item when unselected
  • subnav – A sub-array of subnav items

Subnav arrays should be associative, with identifiable keys set to sub-arrays with the following keys:

  • label – The human-facing subnav item label
  • url – The URL the subnav item should link to

For example:

[
    'label' => 'Commerce',
    'url' => 'commerce',
    'subnav' => [
        'orders' => ['label' => 'Orders', 'url' => 'commerce/orders',
        'discounts' => ['label' => 'Discounts', 'url' => 'commerce/discounts',
    ],
]

Control panel templates can specify which subnav item is selected by defining a selectedSubnavItem variable.

{% set selectedSubnavItem = 'orders' %}

View source

Returns

array

Throws

# settings()

Returns the list of settings.

View source

Returns

array

# Events

# EVENT_REGISTER_CP_NAV_ITEMS

Type
craft\events\RegisterCpNavItemsEvent

The event that is triggered when registering control panel nav items.

use craft\events\RegisterCpNavItemsEvent;
use craft\web\twig\variables\Cp;
use yii\base\Event;

Event::on(Cp::class, Cp::EVENT_REGISTER_CP_NAV_ITEMS, function(RegisterCpNavItemsEvent $e) {
    $e->navItems[] = [
        'label' => 'Item Label',
        'url' => 'my-module',
        'icon' => '/path/to/icon.svg',
    ];
});

craft\events\RegisterCpNavItemsEvent::$navItems is an array whose values are sub-arrays that define the nav items. Each sub-array can have the following keys:

  • label – The item’s label.

  • url – The URL or path of the control panel page the item should link to.

  • icon – The path to the SVG icon that should be used for the item.

  • badgeCount (optional) – The badge count number that should be displayed next to the label.

  • external (optional) – Set to true if the item links to an external URL.

  • id (optional) – The ID of the <li> element. If not specified, it will default to nav-.

  • subnav (optional) – A nested array of sub-navigation items that should be displayed if the main item is selected.

    The keys of the array should define the items’ IDs, and the values should be nested arrays with label and url keys, and optionally badgeCount and external keys.

If a subnav is defined, subpages can specify which subnav item should be selected by defining a selectedSubnavItem variable that is set to the selected item’s ID (its key in the subnav array).

# EVENT_REGISTER_CP_SETTINGS

Type
craft\events\RegisterCpSettingsEvent
Since
3.1.0

The event that is triggered when registering links that should render on the Settings page in the control panel.

use craft\events\RegisterCpSettingsEvent;
use craft\web\twig\variables\Cp;
use yii\base\Event;

Event::on(Cp::class, Cp::EVENT_REGISTER_CP_SETTINGS, function(RegisterCpSettingsEvent $e) {
    $e->settings[Craft::t('app', 'Modules')] = [
        'label' => 'Item Label',
        'url' => 'my-module',
        'icon' => '/path/to/icon.svg',
    ];
});

craft\events\RegisterCpSettingsEvent::$settings is an array whose keys define the section labels, and values are sub-arrays that define the individual links.

Each link array should have the following keys:

  • label – The item’s label.
  • url – The URL or path of the control panel page the item should link to.
  • icon – The path to the SVG icon that should be used for the item.

← CraftVariable →