AdminTheme class

An abstract module intended as a base for admin themes.

See the Module interface (Module.php) for details about each method.

This file is licensed under the MIT license.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the AdminTheme class also inherits all the methods and properties of: WireData and Wire.

Show class?     Show args?       Only hookable?    

Common

NameReturnSummary 
AdminTheme::addBodyClass(string $className)
None

Add a <body> class to the admin theme

 
AdminTheme::addExtraMarkup(string $name, string $value)
None

Add extra markup to a region in the admin theme

 
AdminTheme::get(string $key)
int mixed null string

Get property

 
AdminTheme::getBodyClass()
string

Get the body[class] attribute string

 
AdminTheme::getClass()
string array

Return class for a given named item or blank if none available

 
AdminTheme::getExtraMarkup()
array

Enables hooks to append extra markup to various sections of the admin page

AdminTheme::getLabel(string $key)
string

Get predefined translated label by key for labels shared among admin themes

 
AdminTheme::getModuleInfo()
None

Per the Module interface, return an array of information about the Module

 
AdminTheme::init()
None

Initialize the admin theme system and determine which admin theme should be used

 
AdminTheme::install()
None

Install the admin theme

AdminTheme::isCurrent()
None

Returns true if this admin theme is the one that will be used for this request

 
AdminTheme::path()
string

Get disk path to this admin theme


Can also be used as property: AdminTheme::path 		 
AdminTheme::uninstall()
None
AdminTheme::url()
string

Get URL to this admin theme


Can also be used as property: AdminTheme::url 		 

Properties

NameReturnSummary 
AdminTheme::version int string Current admin theme version 

Additional methods and properties

In addition to the methods and properties above, AdminTheme also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.253