PmWiki

Variables

administrators (basic)


List of documented PHP variables

VariableDocumented in
$AbortFunctionDebug Variables
$ActionSkinLayout Variables
$AddLinkCSSLink Variables
$AllowPasswordSecurity Variables
$AsSpacedFunctionBasic Variables
$AuthIdBasic Variables
$AuthLDAPBindDNSecurity Variables
$AuthLDAPBindPasswordSecurity Variables
$AuthLDAPReferralsSecurity Variables
$AuthorBasic Variables
$AuthorGroupBasic Variables
$AuthPwBasic Variables
$AutoCreateEdit Variables
$BaseNameBasic Variables
$BaseNamePatternsBasic Variables
$BlockedMessagesFmtBlocklist
$BlocklistActionsBlocklist
$BlocklistDownloadBlocklist
$BlocklistDownloadFmtBlocklist
$BlocklistDownloadRefreshBlocklist
$BlocklistMessageFmtBlocklist
$BlocklistPagesBlocklist
$CategoryGroupBasic Variables
$CookiePrefixBasic Variables
$DefaultEmptyPageTextVarsOther Variables
$DefaultGroupBasic Variables
$DefaultNameBasic Variables
$DefaultPageBasic Variables
$DefaultPageCharsetI18n Variables
$DefaultPageTextFmtEdit Variables
$DefaultPasswordsSecurity Variables
$DefaultUnsetPageTextVarsOther Variables
$DeleteKeyPatternEdit Variables
$DenyHtaccessContentSecurity Variables
$DiffKeepDaysEdit Variables
$DiffKeepNumEdit Variables
$DraftActionsPatternEdit Variables
$DraftRecentChangesFmtLayout Variables
$DraftSuffixEdit Variables
$EditFunctionsEdit Variables
$EditRedirectFmtEdit Variables
$EditTemplatesFmtEdit Variables
$EnableAutoSkinListLayout Variables
$EnableBlocklistBlocklist
$EnableBlocklistImmediateBlocklist
$EnableCookieHTTPOnlySecurity Variables
$EnableCookieSecureSecurity Variables
$EnableDiagDebug Variables
$EnableDiffInlineLayout Variables
$EnableDirectDownloadUpload Variables
$EnableDraftAtomicDiffEdit Variables
$EnableDraftsEdit Variables
$EnableEditAutoTextEdit Variables
$EnableFixedUrlRedirectLayout Variables
$EnableGUIButtonsEdit Variables
$EnableGuiEditFixUrlEdit Variables
$EnableHighlightLayout Variables
$EnableIMSCachingDebug Variables
$EnableInputDataAttrOther Variables
$EnableLinkPageRelativeLink Variables
$EnableLinkPlusTitlespacedLink Variables
$EnableLocalConfigBasic Variables
$EnableMarkupDiagDebug Variables
$EnableNotifyNotify
$EnableNotifySubjectEncodeNotify
$EnableNotSavedWarningEdit Variables
$EnablePageIndexPagelist Variables
$EnablePageListProtectPagelist Variables
$EnablePageTitlePriorityLayout Variables
$EnablePageVarAuthSecurity Variables
$EnablePathInfoLayout Variables
$EnablePGCustBasic Variables
$EnablePostAttrClearSessionSecurity Variables
$EnablePostAuthorRequiredEdit Variables
$EnablePreviewChangesEdit Variables
$EnablePublishAttrSecurity Variables
$EnableRCDiffBytesLayout Variables
$EnableRedirectBasic Variables
$EnableRedirectQuietLink Variables
$EnableRelativePageVarsBasic Variables
$EnableRevUserAgentEdit Variables
$EnableRobotCloakActionsSecurity Variables
$EnableROSEscapeEdit Variables
$EnableSelfWikiPageCSSLayout Variables
$EnableSessionPasswordsSecurity Variables
$EnableSimpleTableRowspanLayout Variables
$EnableSortableLayout Variables
$EnableStdConfigBasic Variables
$EnableStopWatchDebug Variables
$EnableTableAutoValignTopLayout Variables
$EnableUndefinedTemplateVarsPagelist Variables
$EnableUploadUpload Variables
$EnableUploadAuthorRequiredEdit 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
$GUIButtonsEdit Variables
$HandleAuthSecurity Variables
$HandleEditFmtEdit Variables
$HTMLFooterFmtLayout Variables
$HTMLHeaderFmtLayout Variables
$HTMLPNewlineLayout Variables
$HTMLStylesFmtLayout Variables
$HTMLTagAttrLayout Variables
$HTMLVSpaceLayout Variables
$IMapLinkFmtLink Variables
$InterMapFilesLink Variables
$IsPagePostedEdit Variables
$LinkCategoryFmtLink Variables
$LinkPageCreateFmtLink Variables
$LinkPageCreateSpaceFmtLink Variables
$LinkPageExistsFmtLink Variables
$LinkPageSelfFmtLink Variables
$LinkUploadCreateFmtUpload Variables
$LinkWikiWordsBasic Variables
$LocalDirPath Variables
$LogoutCookiesBasic Variables
$LogoutRedirectFmtBasic Variables
$MailFunctionNotify
$MakePageNameFunctionLink Variables
$MakePageNamePatternsLink Variables
$MakePageNameSplitPatternLink Variables
$MakeUploadNamePatternsUpload Variables
$MarkupMarkupLevelOther 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
$PageCacheDirOther Variables
$PageCSSListFmtPath Variables
$PageEditFmtEdit Variables
$PageEditFormEdit Variables
$PageIndexFilePagelist Variables
$PageListCacheDirPagelist Variables
$PageListSortCmpFunctionPagelist Variables
$PageListVarFoldFnPagelist Variables
$PageLogoUrlLayout Variables
$pagenameBasic Variables
$PageNotFoundHeaderFmtLayout Variables
$PagePathFmtBasic Variables
$PageRedirectFmtLayout Variables
$PageSearchFormPagelist Variables
$PageSkinListLayout Variables
$PmTOCLayout Variables
$PubDirUrlPath Variables
$QualifyPatternsLink Variables
$RCLinesMaxLayout Variables
$RecentChangesFmtLayout Variables
$RecentUploadsFmtLayout Variables
$RobotActionsSecurity Variables
$RobotPatternSecurity Variables
$ROEPatternsEdit Variables
$ROSPatternsEdit Variables
$ScriptUrlPath Variables
$SearchBoxInputTypePagelist Variables
$SearchBoxOptPagelist Variables
$SearchPatternsPagelist Variables
$SessionDecodeSecurity Variables
$SessionEncodeSecurity Variables
$SetCookieFunctionSecurity Variables
$SimpleTableDefaultClassNameLayout Variables
$SiteAdminGroupBasic Variables
$SiteGroupBasic Variables
$SkinBasic Variables
$SkinDirPath Variables
$SkinDirUrlPath Variables
$SkinLibDirsLayout Variables
$SkinTemplateIncludeLevelLayout Variables
$SpaceWikiWordsBasic Variables
$TableCellAlignFmtLayout Variables
$TableCellAttrFmtLayout Variables
$TableRowAttrFmtLayout Variables
$TableRowIndexMaxLayout Variables
$TimeFmtBasic Variables
$ToggleNextSelectorLayout Variables
$UploadBlacklistUpload Variables
$UploadDirUpload Variables
$UploadDirQuotaUpload Variables
$UploadExtSizeUpload Variables
$UploadMaxSizeUpload Variables
$UploadNameCharsUpload Variables
$UploadPermAddUpload Variables
$UploadPermSetUpload Variables
$UploadPrefixFmtUpload Variables
$UploadPrefixQuotaUpload Variables
$UploadRedirectFunctionUpload Variables
$UploadUrlFmtUpload Variables
$UrlLinkFmtLink Variables
$VarPagesFmtI18n Variables
$VersionBasic Variables
$VersionNumBasic Variables
$WikiDirPath Variables
$WikiLibDirsPath Variables
$WikiPageCSSFmtLayout Variables
$WikiPageCSSVarsLayout Variables
$WikiStyleLayout Variables
$WikiStyleApplyLayout Variables
$WikiTitleLayout Variables
$WikiWordCountLink Variables
$WikiWordCountMaxLink Variables
$WikiWordPatternBasic Variables
$WorkDirPath Variables
$XLLangsI18n 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:

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 Wiki Words ($WikiWordPattern) preceded with “$”. Therefore all “non Wiki Word” 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.

See Also

Categories: PmWiki Developer


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