Variables

< Url approvals | Documentation Index | Functions >

administrators (basic)

List of documented PHP variables

Variable	Documented in
`$AbortFunction`	Debug Variables
`$ActionSkin`	Layout Variables
`$AddLinkCSS`	Link Variables
`$AllowPassword`	Security Variables
`$AsSpacedFunction`	Basic Variables
`$AuthId`	Basic Variables
`$AuthLDAPBindDN`	Security Variables
`$AuthLDAPBindPassword`	Security Variables
`$AuthLDAPReferrals`	Security Variables
`$Author`	Basic Variables
`$AuthorGroup`	Basic Variables
`$AuthPw`	Basic Variables
`$AutoCreate`	Edit Variables
`$BaseName`	Basic Variables
`$BaseNamePatterns`	Basic Variables
`$BlockedMessagesFmt`	Blocklist
`$BlocklistActions`	Blocklist
`$BlocklistDownload`	Blocklist
`$BlocklistDownloadFmt`	Blocklist
`$BlocklistDownloadRefresh`	Blocklist
`$BlocklistMessageFmt`	Blocklist
`$BlocklistPages`	Blocklist
`$CategoryGroup`	Basic Variables
`$CookiePrefix`	Basic Variables
`$DefaultEmptyPageTextVars`	Other Variables
`$DefaultGroup`	Basic Variables
`$DefaultName`	Basic Variables
`$DefaultPage`	Basic Variables
`$DefaultPageCharset`	I18n Variables
`$DefaultPageTextFmt`	Edit Variables
`$DefaultPasswords`	Security Variables
`$DefaultUnsetPageTextVars`	Other Variables
`$DeleteKeyPattern`	Edit Variables
`$DenyHtaccessContent`	Security Variables
`$DiffKeepDays`	Edit Variables
`$DiffKeepNum`	Edit Variables
`$DraftActionsPattern`	Edit Variables
`$DraftRecentChangesFmt`	Layout Variables
`$DraftSuffix`	Edit Variables
`$EditFunctions`	Edit Variables
`$EditRedirectFmt`	Edit Variables
`$EditTemplatesFmt`	Edit Variables
`$EnableBlocklist`	Blocklist
`$EnableBlocklistImmediate`	Blocklist
`$EnableCookieHTTPOnly`	Security Variables
`$EnableCookieSecure`	Security Variables
`$EnableDiag`	Debug Variables
`$EnableDiffInline`	Layout Variables
`$EnableDirectDownload`	Upload Variables
`$EnableDraftAtomicDiff`	Edit Variables
`$EnableDrafts`	Edit Variables
`$EnableEditAutoText`	Edit Variables
`$EnableFixedUrlRedirect`	Layout Variables
`$EnableGUIButtons`	Edit Variables
`$EnableGuiEditFixUrl`	Edit Variables
`$EnableHighlight`	Layout Variables
`$EnableIMSCaching`	Debug Variables
`$EnableInputDataAttr`	Other Variables
`$EnableLinkPageRelative`	Link Variables
`$EnableLinkPlusTitlespaced`	Link Variables
`$EnableLocalConfig`	Basic Variables
`$EnableMarkupDiag`	Debug Variables
`$EnableNotify`	Notify
`$EnableNotifySubjectEncode`	Notify
`$EnableNotSavedWarning`	Edit Variables
`$EnablePageIndex`	Pagelist Variables
`$EnablePageListProtect`	Pagelist Variables
`$EnablePageTitlePriority`	Layout Variables
`$EnablePageVarAuth`	Security Variables
`$EnablePathInfo`	Layout Variables
`$EnablePGCust`	Basic Variables
`$EnablePostAttrClearSession`	Security Variables
`$EnablePostAuthorRequired`	Edit Variables
`$EnablePreviewChanges`	Edit Variables
`$EnablePublishAttr`	Security Variables
`$EnableRCDiffBytes`	Layout Variables
`$EnableRedirect`	Basic Variables
`$EnableRedirectQuiet`	Link Variables
`$EnableRelativePageVars`	Basic Variables
`$EnableRevUserAgent`	Edit Variables
`$EnableRobotCloakActions`	Security Variables
`$EnableROSEscape`	Edit Variables
`$EnableSelfWikiPageCSS`	Layout Variables
`$EnableSessionPasswords`	Security Variables
`$EnableSimpleTableRowspan`	Layout Variables
`$EnableSortable`	Layout Variables
`$EnableStdConfig`	Basic Variables
`$EnableStopWatch`	Debug Variables
`$EnableTableAutoValignTop`	Layout Variables
`$EnableUndefinedTemplateVars`	Pagelist Variables
`$EnableUpload`	Upload Variables
`$EnableUploadAuthorRequired`	Edit Variables
`$EnableUploadGroupAuth`	Upload Variables
`$EnableUploadOverwrite`	Upload Variables
`$EnableUploadVersions`	Upload Variables
`$EnableWhyBlocked`	Blocklist
`$EnableWikiWords`	Basic Variables
`$EnableWSPre`	Basic Variables
`$EnableXLPageScriptLoad`	I18n Variables
`$FarmD`	Path Variables
`$FarmPubDirUrl`	Path Variables
`$FmtP`	Other Variables
`$FmtPV`	Other Variables
`$FmtV`	Other Variables
`$FPLTemplatePageFmt`	Pagelist Variables
`$FTimeFmt`	Basic Variables
`$GroupFooterFmt`	Layout Variables
`$GroupHeaderFmt`	Layout Variables
`$GroupPattern`	Basic Variables
`$GroupPrintFooterFmt`	Layout Variables
`$GroupPrintHeaderFmt`	Layout Variables
`$GUIButtons`	Edit Variables
`$HandleAuth`	Security Variables
`$HandleEditFmt`	Edit Variables
`$HTMLFooterFmt`	Layout Variables
`$HTMLHeaderFmt`	Layout Variables
`$HTMLPNewline`	Layout Variables
`$HTMLStylesFmt`	Layout Variables
`$HTMLTagAttr`	Layout Variables
`$HTMLVSpace`	Layout Variables
`$IMapLinkFmt`	Link Variables
`$InterMapFiles`	Link Variables
`$IsPagePosted`	Edit Variables
`$LinkCategoryFmt`	Link Variables
`$LinkPageCreateFmt`	Link Variables
`$LinkPageCreateSpaceFmt`	Link Variables
`$LinkPageExistsFmt`	Link Variables
`$LinkPageSelfFmt`	Link Variables
`$LinkUploadCreateFmt`	Upload Variables
`$LinkWikiWords`	Basic Variables
`$LocalDir`	Path Variables
`$LogoutCookies`	Basic Variables
`$LogoutRedirectFmt`	Basic Variables
`$MailFunction`	Notify
`$MakePageNameFunction`	Link Variables
`$MakePageNamePatterns`	Link Variables
`$MakePageNameSplitPattern`	Link Variables
`$MakeUploadNamePatterns`	Upload Variables
`$MarkupMarkupLevel`	Other Variables
`$MaxIncludes`	Layout Variables
`$MaxPageTextVars`	Other Variables
`$MessagesFmt`	Layout Variables
`$MetaRobots`	Layout Variables
`$NamePattern`	Basic Variables
`$NotifyBodyFmt`	Notify
`$NotifyDelay`	Notify
`$NotifyFile`	Notify
`$NotifyFrom`	Notify
`$NotifyHeaders`	Notify
`$NotifyItemFmt`	Notify
`$NotifyList`	Notify
`$NotifyListPageFmt`	Notify
`$NotifyParameters`	Notify
`$NotifySquelch`	Notify
`$NotifySubjectFmt`	Notify
`$NotifyTimeFmt`	Notify
`$PageAttributes`	Security Variables
`$PageCacheDir`	Other Variables
`$PageCSSListFmt`	Path Variables
`$PageEditFmt`	Edit Variables
`$PageEditForm`	Edit Variables
`$PageIndexFile`	Pagelist Variables
`$PageListCacheDir`	Pagelist Variables
`$PageListSortCmpFunction`	Pagelist Variables
`$PageListVarFoldFn`	Pagelist Variables
`$PageLogoUrl`	Layout Variables
`$pagename`	Basic Variables
`$PageNotFoundHeaderFmt`	Layout Variables
`$PagePathFmt`	Basic Variables
`$PageRedirectFmt`	Layout Variables
`$PageSearchForm`	Pagelist Variables
`$PmTOC`	Layout Variables
`$PubDirUrl`	Path Variables
`$QualifyPatterns`	Link Variables
`$RCLinesMax`	Layout Variables
`$RecentChangesFmt`	Layout Variables
`$RecentUploadsFmt`	Layout Variables
`$RobotActions`	Security Variables
`$RobotPattern`	Security Variables
`$ROEPatterns`	Edit Variables
`$ROSPatterns`	Edit Variables
`$ScriptUrl`	Path Variables
`$SearchBoxInputType`	Pagelist Variables
`$SearchBoxOpt`	Pagelist Variables
`$SearchPatterns`	Pagelist Variables
`$SessionDecode`	Security Variables
`$SessionEncode`	Security Variables
`$SetCookieFunction`	Security Variables
`$SimpleTableDefaultClassName`	Layout Variables
`$SiteAdminGroup`	Basic Variables
`$SiteGroup`	Basic Variables
`$Skin`	Basic Variables
`$SkinDir`	Path Variables
`$SkinDirUrl`	Path Variables
`$SkinLibDirs`	Layout Variables
`$SkinTemplateIncludeLevel`	Layout Variables
`$SpaceWikiWords`	Basic Variables
`$TableCellAlignFmt`	Layout Variables
`$TableCellAttrFmt`	Layout Variables
`$TableRowAttrFmt`	Layout Variables
`$TableRowIndexMax`	Layout Variables
`$TimeFmt`	Basic Variables
`$ToggleNextSelector`	Layout Variables
`$UploadBlacklist`	Upload Variables
`$UploadDir`	Upload Variables
`$UploadDirQuota`	Upload Variables
`$UploadExtSize`	Upload Variables
`$UploadMaxSize`	Upload Variables
`$UploadNameChars`	Upload Variables
`$UploadPermAdd`	Upload Variables
`$UploadPermSet`	Upload Variables
`$UploadPrefixFmt`	Upload Variables
`$UploadPrefixQuota`	Upload Variables
`$UploadRedirectFunction`	Upload Variables
`$UploadUrlFmt`	Upload Variables
`$UrlLinkFmt`	Link Variables
`$VarPagesFmt`	I18n Variables
`$Version`	Basic Variables
`$VersionNum`	Basic Variables
`$WikiDir`	Path Variables
`$WikiLibDirs`	Path Variables
`$WikiPageCSSFmt`	Layout Variables
`$WikiPageCSSVars`	Layout Variables
`$WikiStyle`	Layout Variables
`$WikiStyleApply`	Layout Variables
`$WikiTitle`	Layout Variables
`$WikiWordCount`	Link Variables
`$WikiWordCountMax`	Link Variables
`$WikiWordPattern`	Basic Variables
`$WorkDir`	Path Variables
`$XLLangs`	I18n Variables

This page documents the PHP variables available in PmWiki for local customizations. Much of this documentation is still incomplete but people are working on it now. Feel free to add placeholders for variables you want to have documented if you don't know what the variable does.

The variables documentation is divided into several pages:

Basic Variables - core variables
Debug Variables - variables useful for debugging
Edit Variables - variables used when editing pages
I18n Variables - variables used for internationalization (i18n)
Layout Variables - variables that control page layout
Link Variables - variables that control the display of links in pages
Other Variables - Variables not yet classified
Pagelist Variables - variables used with page lists and search results
Path Variables - variables used to specify various locations on the server
Security Variables - variables crucial for site security
Upload Variables - Variables used for uploads/attachments

The following functions are also controlled by several variables:

Blocklist - Blocking IP addresses, phrases, and expressions to counteract spam and vandalism.
Notify - How to receive email messages whenever pages are changed on the whole wiki site, individual groups or selected watchlists of pages
Basic Variables to provide circular trail

The following variables are used in page markup.

Page Variables - variables that are associated with pages
Page TextVariables - Page variables automatically made available through natural or explicit page markup

An complete index of documented PHP variables is given below.

In general, variables with names ending in 'Fmt' (such as $PageLayoutFmt) have their values processed for $-variable substitutions prior to being output. Thus strings such as {$Name} and {$PageUrl} are replaced with the name and URL of the page when the string is printed.

Note: The automatic variable index and link generation is done by scripts/vardoc.php using $VarPagesFmt to find the pages containing trails of pages with the variable documentation.

There is a slight discrepancy between index generation and link generation: The index generation finds lines starting with a colon followed by "$" and an uppercase word. In contrast, the automatic link generation works only with WikiWords ($WikiWordPattern) preceded with "$". Therefore all "non WikiWord" variables are shown as link only in the list below, but not elsewhere in PmWiki, as $XL. 'Author', 'Skin', 'pagename' and 'Version' (preceded with a $-sign) are handled correctly.

Variables

List of documented PHP variables

See Also