< Url approvals | Documentation index | Functions >

administrators (basic)

This page documents the 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

PHP Variables

PmWiki Page Variables - set and used only in PmWiki pages

A complete index of documented 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.

See Also

  • Blocklist - Blocking IP addresses, phrases, and expressions to counteract spam and vandalism.
  • Notify - Allows a site administrator to configure PmWiki to send email messages whenever pages are changed on the wiki site
  • Functions - How some of the functions in pmwiki.php work
  • Basic Variables to provide circular trail

VariableDocumented in
$ActionSkinLayoutVariables
$AsSpacedFunctionBasicVariables
$AuthIdBasicVariables
$AuthLDAPBindDNSecurityVariables
$AuthLDAPBindPasswordSecurityVariables
$AuthPwBasicVariables
$AuthUserFunctionsSecurityVariables
$AuthorBasicVariables
$AuthorGroupBasicVariables
$AutoCreateEditVariables
$BaseNamePatternsBasicVariables
$BlockedMessagesFmtBlocklist
$BlocklistActionsBlocklist
$BlocklistDownloadBlocklist
$BlocklistDownloadFmtBlocklist
$BlocklistDownloadRefreshBlocklist
$BlocklistMessageFmtBlocklist
$BlocklistPagesBlocklist
$CategoryGroupBasicVariables
$CookiePrefixBasicVariables
$DefaultGroupBasicVariables
$DefaultNameBasicVariables
$DefaultPageBasicVariables
$DefaultPageTextFmtEditVariables
$DefaultPasswordsSecurityVariables
$DeleteKeyPatternEditVariables
$DiffKeepDaysEditVariables
$DraftRecentChangesFmtLayoutVariables
$DraftSuffixEditVariables
$EditFunctionsEditVariables
$EditRedirectFmtEditVariables
$EditTemplatesFmtEditVariables
$EnableBlocklistBlocklist
$EnableBlocklistImmediateBlocklist
$EnableDiagDebugVariables
$EnableDirectDownloadUploadVariables
$EnableDraftsEditVariables
$EnableFixedUrlRedirectLayoutVariables
$EnableGUIButtonsEditVariables
$EnableIMSCachingDebugVariables
$EnableLinkPageRelativeLinkVariables
$EnableLocalConfigBasicVariables
$EnableNotifyNotify
$EnableNotifySubjectEncodeNotify
$EnablePGCustBasicVariables
$EnablePageIndexPagelistVariables
$EnablePageListProtectPagelistVariables
$EnablePathInfoLayoutVariables
$EnablePostAttrClearSessionSecurityVariables
$EnablePostAuthorRequiredEditVariables
$EnablePublishAttrSecurityVariables
$EnableRedirectBasicVariables
$EnableRedirectQuietLinkVariables
$EnableSessionPasswordsSecurityVariables
$EnableStopWatchDebugVariables
$EnableUploadUploadVariables
$EnableUploadGroupAuthUploadVariables
$EnableUploadOverwriteUploadVariables
$EnableUploadVersionsUploadVariables
$EnableWSPreBasicVariables
$EnableWhyBlockedBlocklist
$EnableWikiWordsBasicVariables
$FPLTemplatePageFmtPagelistVariables
$FTimeFmtBasicVariables
$FarmDPathVariables
$FarmPubDirUrlPathVariables
$FmtPOtherVariables
$FmtPVOtherVariables
$FmtVOtherVariables
$GroupFooterFmtLayoutVariables
$GroupHeaderFmtLayoutVariables
$GroupPatternBasicVariables
$GroupPrintFooterFmtLayoutVariables
$GroupPrintHeaderFmtLayoutVariables
$HTMLFooterFmtLayoutVariables
$HTMLHeaderFmtLayoutVariables
$HTMLStylesFmtLayoutVariables
$HTMLVSpaceLayoutVariables
$HandleAuthSecurityVariables
$HandleEditFmtEditVariables
$IMapLinkFmtLinkVariables
$InterMapFilesLinkVariables
$IsPagePostedEditVariables
$LinkPageCreateFmtLinkVariables
$LinkPageCreateSpaceFmtLinkVariables
$LinkPageExistsFmtLinkVariables
$LinkPageSelfFmtLinkVariables
$LinkUploadCreateFmtUploadVariables
$LinkWikiWordsBasicVariables
$LocalDirPathVariables
$LogoutCookiesBasicVariables
$LogoutRedirectFmtBasicVariables
$MakePageNameFunctionLinkVariables
$MakePageNamePatternsLinkVariables
$MakeUploadNamePatternsUploadVariables
$MaxIncludesLayoutVariables
$MaxPageTextVarsOtherVariables
$MessagesFmtLayoutVariables
$MetaRobotsLayoutVariables
$NamePatternBasicVariables
$NotifyBodyFmtNotify
$NotifyDelayNotify
$NotifyFileNotify
$NotifyFromNotify
$NotifyHeadersNotify
$NotifyItemFmtNotify
$NotifyListNotify
$NotifyListPageFmtNotify
$NotifyParametersNotify
$NotifySquelchNotify
$NotifySubjectFmtNotify
$NotifyTimeFmtNotify
$PageAttributesSecurityVariables
$PageCSSListFmtPathVariables
$PageEditFmtEditVariables
$PageEditFormEditVariables
$PageIndexFilePagelistVariables
$PageListCacheDirPagelistVariables
$PageLogoUrlLayoutVariables
$PageNotFoundHeaderFmtLayoutVariables
$PagePathFmtLinkVariables
$PageRedirectFmtLayoutVariables
$PageSearchFormPagelistVariables
$PubDirUrlPathVariables
$RCLinesMaxLayoutVariables
$ROEPatternsEditVariables
$ROSPatternsEditVariables
$RecentChangesFmtLayoutVariables
$RecentUploadsFmtLayoutVariables
$ScriptUrlPathVariables
$SearchBoxOptPagelistVariables
$SearchPatternsPagelistVariables
$SessionDecodeSecurityVariables
$SessionEncodeSecurityVariables
$SiteAdminGroupBasicVariables
$SiteGroupBasicVariables
$SkinDirUrlPathVariables
$SkinLibDirsLayoutVariables
$SpaceWikiWordsBasicVariables
$TableCellAttrFmtLayoutVariables
$TableRowAttrFmtLayoutVariables
$TableRowIndexMaxLayoutVariables
$TimeFmtBasicVariables
$UploadDirUploadVariables
$UploadDirQuotaUploadVariables
$UploadMaxSizeUploadVariables
$UploadNameCharsUploadVariables
$UploadPrefixFmtUploadVariables
$UploadPrefixQuotaUploadVariables
$UploadUrlFmtUploadVariables
$UrlLinkFmtLinkVariables
$VarPagesFmtI18nVariables
$VersionBasicVariables
$VersionNumBasicVariables
$WikiDirPathVariables
$WikiLibDirsPathVariables
$WikiStyleLayoutVariables
$WikiTitleLayoutVariables
$WikiWordCountLinkVariables
$WikiWordCountMaxLinkVariables
$WikiWordPatternBasicVariables
$WorkDirPathVariables
$XLI18nVariables
$XLLangsI18nVariables

< Url approvals | Documentation index | Functions >


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