AdminThemeFramework class

Located in file /wire/core/AdminThemeFramework.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 AdminThemeFramework class also inherits all the methods and properties of: AdminTheme, WireData and Wire.

Show class?             Show args?        

Common

NameReturnSummary 
AdminThemeFramework::allowPageInNav(Page $p)
boolAllow the given Page to appear in admin theme navigation? 
AdminThemeFramework::browserTitle string Optional custom browser title for this request (3.0.217+) 
AdminThemeFramework::get(string $key)
bool int mixed null stringOverride get() method from WireData to support additional properties 
AdminThemeFramework::getAddNewActions()
arrayGet “Add New” button actions 
AdminThemeFramework::getAddNewLabel()
stringGet the translated “Add New” label that’s used in a couple spots 
AdminThemeFramework::getBodyClass()
stringGet the classes that will be used in the <body class=''> tag 
AdminThemeFramework::getBrowserTitle()
stringGet the browser <title> 
AdminThemeFramework::getHeadJS()
stringGet Javascript that must be present in the document <head> 
AdminThemeFramework::getHeadline()
stringGet the current page headline 
AdminThemeFramework::getModuleConfigInputfields(InputfieldWrapper $inputfields)
(nothing)Module Configuration 
AdminThemeFramework::getPageIcon(Page $p)
mixed null stringGet icon used by the given page 
AdminThemeFramework::getPageTitle(Page $p)
stringGet navigation title for the given page, return blank if page should not be shown 
AdminThemeFramework::getPrimaryNavArray()
arrayReturn nav array of primary navigation
AdminThemeFramework::getUserNavArray()
arrayGet navigation items for the “user” menu
AdminThemeFramework::includeFile(string $basename)
(nothing)Include an admin theme file 
AdminThemeFramework::includeInitFile()
(nothing)Include the admin theme init file 
AdminThemeFramework::init()
(nothing)Initialize and attach hooks 
AdminThemeFramework::isEditor bool 
AdminThemeFramework::isLoggedIn bool 
AdminThemeFramework::isModal bool string 
AdminThemeFramework::isSuperuser bool 
AdminThemeFramework::moduleToNavArray($module, Page $p)
arrayGet navigation array from a Process module 
AdminThemeFramework::pageToNavArray(Page $p)
array nullGet a navigation array the given Page, or null if page not allowed in nav 
AdminThemeFramework::renderExtraMarkup(string $for)
mixed stringRender an extra markup region 
AdminThemeFramework::renderIcon(string $icon)
stringRender markup for a font-awesome icon 
AdminThemeFramework::renderNavIcon(string $icon)
stringRender markup for a font-awesome icon that precedes a navigation label 
AdminThemeFramework::renderNotices($notices)
string arrayRender runtime notices div#notices 
AdminThemeFramework::setCustomTemplatePath(string $path)
(nothing)Set custom path for admin theme templates 
AdminThemeFramework::testNotices()
boolTest all notice types 
AdminThemeFramework::useAsLogin bool int 
AdminThemeFramework::wired()
(nothing) 

For hooks

These methods are only useful for hooking and should not be called directly.

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #532
    In the 532nd issue of ProcessWire Weekly we'll cover the latest core updates, check out a couple of brand-new third party modules, and more. Read on!
    Weekly.pw / 20 July 2024
  • Page List Custom Children module
    This simple module gives you the ability to customize the parent/child relationship as it appears in the admin page list, enabling child pages to appear under more than one parent.
    Blog / 28 June 2024
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer