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

For hooks

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

NameReturnSummary 
renderFile(string $file)
stringRender a admin theme template file

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.244

“I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer