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::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::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::testNotices()
boolTest all notice types 
AdminThemeFramework::useAsLogin bool int 

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

Twitter updates

  • This post covers a few of the bigger updates in ProcessWire 3.0.154+3.0.155. This includes new live replacement of text in core and modules, a new method for creating canonical URLs, and some major upgrades to our input->urlSegment() method! More
    24 April 2020
  • A brief look at what's new in ProcessWire 3.0.154 in this forum post: More
    17 April 2020
  • This week we’ve got a few new and interesting core updates in progress, though none quite ready to release just yet. So rather than releasing version 3.0.154 today, I thought we'd instead take a brief look at what’s coming over the next few weeks… More
    3 April 2020

Latest news

  • ProcessWire Weekly #311
    In the 311th issue of ProcessWire Weekly we're going to talk a bit about the latest dev versions of ProcessWire, introduce a couple of new third party modules, and more. Read on!
    Weekly.pw / 25 April 2020
  • ProcessWire 3.0.154 and 3.0.155 core updates
    This post covers a few of the bigger updates in ProcessWire 3.0.154 and 3.0.155 on the dev branch. This includes a new function for live replacement of text in core and modules, a new method for creating canonical URLs, and some major upgrades to our $input->urlSegment() method that I think you’ll like!
    Blog / 24 April 2020
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer