AdminTheme class

Located in file /wire/core/AdminTheme.php

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?        

Common

NameReturnSummary 
AdminTheme::addBodyClass(string $className)
(nothing)Add a <body> class to the admin theme 
AdminTheme::addExtraMarkup(string $name, string $value)
(nothing)Add extra markup to a region in the admin theme 
AdminTheme::get(string $key)
int mixed null stringGet property 
AdminTheme::getBodyClass()
stringGet the body[class] attribute string 
AdminTheme::getClass()
string arrayReturn class for a given named item or blank if none available 
AdminTheme::getExtraMarkup()
arrayEnables hooks to append extra markup to various sections of the admin page
AdminTheme::getLabel(string $key)
stringGet predefined translated label by key for labels shared among admin themes 
AdminTheme::getModuleInfo()
(nothing)Per the Module interface, return an array of information about the Module 
AdminTheme::init()
(nothing)Initialize the admin theme system and determine which admin theme should be used 
AdminTheme::install()
(nothing)Install the admin theme
AdminTheme::isCurrent()
(nothing)Returns true if this admin theme is the one that will be used for this request 
AdminTheme::path()
stringGet disk path to this admin theme
Can also be used as property: AdminTheme::path
 
AdminTheme::uninstall()
(nothing)
AdminTheme::url()
stringGet URL to this admin theme
Can also be used as property: AdminTheme::url
 
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.244

Latest news

  • ProcessWire Weekly #559
    The 559th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 25 January 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits