Recent Changes - Search:
PmWiki /

Variables

administrators (basic)

This page documents the PHP variables available in Pm Wiki 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.

Note: Do not confuse these PHP variables with Page Variables and Page TextVariables being used in page markup.

The variables documentation is divided into several pages:

The following functions are also controlled by several variables:

  • Blocklist - Blocking IP addresses, phrases, and expressions to counteract spam and vandalism.
  • Notify - Allows a site administrator to configure Pm Wiki to send email messages whenever pages are changed on the wiki site
  • Basic Variables to provide circular trail

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 Wiki Words ($WikiWordPattern) preceded by "$". Therefore all "non Wiki Word" variables are shown as link only in the list below, but not elsewhere in Pm Wiki, as $Author, $Version and $XL.

See Also

  • Functions - How some of the functions in pmwiki.php work

List of documented PHP variables

VariableDocumented in
$ActionSkinLayout Variables
$AsSpacedFunctionBasic Variables
$AuthIdBasic Variables
$AuthLDAPBindDNSecurity Variables
$AuthLDAPBindPasswordSecurity Variables
$AuthorGroupBasic Variables
$AuthPwBasic Variables
$AuthUserFunctionsSecurity Variables
$AutoCreateEdit Variables
$BaseNameBasic Variables
$BaseNamePatternsBasic Variables
$BlockedMessagesFmtBlocklist
$BlocklistActionsBlocklist
$BlocklistDownloadBlocklist
$BlocklistDownloadFmtBlocklist
$BlocklistDownloadRefreshBlocklist
$BlocklistMessageFmtBlocklist
$BlocklistPagesBlocklist
$CategoryGroupBasic Variables
$CookiePrefixBasic Variables
$DefaultGroupBasic Variables
$DefaultNameBasic Variables
$DefaultPageBasic Variables
$DefaultPageTextFmtEdit Variables
$DefaultPasswordsSecurity Variables
$DeleteKeyPatternEdit Variables
$DiffKeepDaysEdit Variables
$DiffKeepNumEdit Variables
$DraftRecentChangesFmtLayout Variables
$DraftSuffixEdit Variables
$EditFunctionsEdit Variables
$EditRedirectFmtEdit Variables
$EditTemplatesFmtEdit Variables
$EnableBlocklistBlocklist
$EnableBlocklistImmediateBlocklist
$EnableDiagDebug Variables
$EnableDiffInlineLayout Variables
$EnableDirectDownloadUpload Variables
$EnableDraftsEdit Variables
$EnableFixedUrlRedirectLayout Variables
$EnableGUIButtonsEdit Variables
$EnableIMSCachingDebug Variables
$EnableLinkPageRelativeLink Variables
$EnableLocalConfigBasic Variables
$EnableNotifyNotify
$EnableNotifySubjectEncodeNotify
$EnablePageIndexPagelist Variables
$EnablePageListProtectPagelist Variables
$EnablePageTitlePriorityLayout Variables
$EnablePageVarAuthSecurity Variables
$EnablePathInfoLayout Variables
$EnablePGCustBasic Variables
$EnablePostAttrClearSessionSecurity Variables
$EnablePostAuthorRequiredEdit Variables
$EnablePublishAttrSecurity Variables
$EnableRedirectBasic Variables
$EnableRedirectQuietLink Variables
$EnableRelativePageVarsBasic Variables
$EnableSessionPasswordsSecurity Variables
$EnableStopWatchDebug Variables
$EnableUndefinedTemplateVarsPagelist Variables
$EnableUploadUpload Variables
$EnableUploadGroupAuthUpload Variables
$EnableUploadOverwriteUpload Variables
$EnableUploadVersionsUpload Variables
$EnableWhyBlockedBlocklist
$EnableWikiWordsBasic Variables
$EnableWSPreBasic Variables
$EnableXLPageScriptLoadI18n Variables
$FarmDPath Variables
$FarmPubDirUrlPath Variables
$FmtPOther Variables
$FmtPVOther Variables
$FmtVOther Variables
$FPLTemplatePageFmtPagelist Variables
$FTimeFmtBasic Variables
$GroupFooterFmtLayout Variables
$GroupHeaderFmtLayout Variables
$GroupPatternBasic Variables
$GroupPrintFooterFmtLayout Variables
$GroupPrintHeaderFmtLayout Variables
$HandleAuthSecurity Variables
$HandleEditFmtEdit Variables
$HTMLFooterFmtLayout Variables
$HTMLHeaderFmtLayout Variables
$HTMLStylesFmtLayout Variables
$HTMLVSpaceLayout Variables
$IMapLinkFmtLink Variables
$InterMapFilesLink Variables
$IsPagePostedEdit Variables
$LinkPageCreateFmtLink Variables
$LinkPageCreateSpaceFmtLink Variables
$LinkPageExistsFmtLink Variables
$LinkPageSelfFmtLink Variables
$LinkUploadCreateFmtUpload Variables
$LinkWikiWordsBasic Variables
$LocalDirPath Variables
$LogoutCookiesBasic Variables
$LogoutRedirectFmtBasic Variables
$MakePageNameFunctionLink Variables
$MakePageNamePatternsLink Variables
$MakeUploadNamePatternsUpload Variables
$MaxIncludesLayout Variables
$MaxPageTextVarsOther Variables
$MessagesFmtLayout Variables
$MetaRobotsLayout Variables
$NamePatternBasic Variables
$NotifyBodyFmtNotify
$NotifyDelayNotify
$NotifyFileNotify
$NotifyFromNotify
$NotifyHeadersNotify
$NotifyItemFmtNotify
$NotifyListNotify
$NotifyListPageFmtNotify
$NotifyParametersNotify
$NotifySquelchNotify
$NotifySubjectFmtNotify
$NotifyTimeFmtNotify
$PageAttributesSecurity Variables
$PageCSSListFmtPath Variables
$PageEditFmtEdit Variables
$PageEditFormEdit Variables
$PageIndexFilePagelist Variables
$PageListCacheDirPagelist Variables
$PageLogoUrlLayout Variables
$PageNotFoundHeaderFmtLayout Variables
$PagePathFmtLink Variables
$PageRedirectFmtLayout Variables
$PageSearchFormPagelist Variables
$PubDirUrlPath Variables
$RCLinesMaxLayout Variables
$RecentChangesFmtLayout Variables
$RecentUploadsFmtLayout Variables
$ROEPatternsEdit Variables
$ROSPatternsEdit Variables
$ScriptUrlPath Variables
$SearchBoxOptPagelist Variables
$SearchPatternsPagelist Variables
$SessionDecodeSecurity Variables
$SessionEncodeSecurity Variables
$SiteAdminGroupBasic Variables
$SiteGroupBasic Variables
$SkinDirUrlPath Variables
$SkinLibDirsLayout Variables
$SpaceWikiWordsBasic Variables
$TableCellAttrFmtLayout Variables
$TableRowAttrFmtLayout Variables
$TableRowIndexMaxLayout Variables
$TimeFmtBasic Variables
$UploadDirUpload Variables
$UploadDirQuotaUpload Variables
$UploadExtSizeUpload Variables
$UploadMaxSizeUpload Variables
$UploadNameCharsUpload Variables
$UploadPrefixFmtUpload Variables
$UploadPrefixQuotaUpload Variables
$UploadUrlFmtUpload Variables
$UrlLinkFmtLink Variables
$VarPagesFmtI18n Variables
$VersionBasic Variables
$VersionNumBasic Variables
$WikiDirPath Variables
$WikiLibDirsPath Variables
$WikiStyleLayout Variables
$WikiStyleApplyLayout Variables
$WikiTitleLayout Variables
$WikiWordCountLink Variables
$WikiWordCountMaxLink Variables
$WikiWordPatternBasic Variables
$WorkDirPath Variables
$XLLangsI18n Variables
where is this documented?


This page may have a more recent version on pmwiki.org: PmWiki:Variables, and a talk page: PmWiki:Variables-Talk.