Variables

< Url approvals | Documentation Index | Functions >

administrators (basic)


List of documented PHP variables

VariableDocumented in
$AsSpacedFunctionVariables de base
$AuthIDVariables de base
$AuthorGroupVariables de base
$AutoCreateVariables d'édition
$CookiePrefixVariables de base
$DefaultGroupVariables de base
$DefaultNameVariables de base
$DefaultPageVariables de base
$DefaultPageTextFmtVariables d'édition
$DeleteKeyPatternVariables d'édition
$DiffKeepDaysVariables d'édition
$DraftSuffixVariables d'édition
$EditFunctionsVariables d'édition
$EditRedirectFmtVariables d'édition
$EditTemplatesFmtVariables d'édition
$EnableDirectDownloadVariables pour le téléchargement
$EnableDraftsVariables d'édition
$EnableGUIButtonsVariables d'édition
$EnableIMSCachingAutres variables
$EnableMailPostsNotification par courriel
$EnablePageIndexVariables pour listes de pages
$EnablePageListProtectVariables pour listes de pages
$EnablePathInfoVariables de mise en page
$EnablePGCustVariables de base
$EnablePostAuthorRequiredVariables d'édition
$EnableUploadVariables pour le téléchargement
$EnableWikiWordsVariables de base
$EnableWSPreVariables de base
$FarmDVariables d'emplacements
$FarmPubDirUrlVariables d'emplacements
$GroupPatternVariables de base
$HandleEditFmtVariables d'édition
$HTMLHeaderFmtVariables de mise en page
$HTMLStylesFmtVariables de mise en page
$IsPagePostedVariables d'édition
$LastModifiedByVariables de base
$LinkPageCreateFmtVariables de liens
$LinkPageCreateSpaceFmtVariables de liens
$LinkPageExistsFmtVariables de liens
$LinkPageSelfFmtVariables de liens
$LinkWikiWordsVariables de base
$LogoutCookiesVariables de base
$LogoutRedirectFmtVariables de base
$MailPostsDelayNotification par courriel
$MailPostsFileNotification par courriel
$MailPostsFromNotification par courriel
$MailPostsFunctionNotification par courriel
$MailPostsHeadersNotification par courriel
$MailPostsItemFmtNotification par courriel
$MailPostsMessageNotification par courriel
$MailPostsSquelchNotification par courriel
$MailPostsSubjectNotification par courriel
$MailPostsTimeFmtNotification par courriel
$MailPostsToNotification par courriel
$MakePageNameFunctionVariables de liens
$MaxIncludesVariables de mise en page
$MetaRobotsAutres variables
$NamePatternVariables de base
$PageCSSListFmtVariables d'emplacements
$PageEditFmtVariables d'édition
$PageEditFormVariables d'édition
$PageIndexFileVariables pour listes de pages
$PagePathFmtVariables de liens
$PagePreviewFmtVariables d'édition
$PageRedirectFmtVariables de mise en page
$PageSearchFormVariables pour listes de pages
$PubDirUrlVariables d'emplacements
$RecentChangesFmtVariables de mise en page
$ROSPatternsVariables d'édition
$ScriptUrlVariables d'emplacements
$SearchPatternsAutres variables
$SiteAdminGroupVariables de base
$SiteGroupVariables de base
$SkinVariables de mise en page
$SkinDirUrlVariables d'emplacements
$SpaceWikiWordsVariables de base
$TableCellAttrFmtAutres variables
$TableRowAttrFmtAutres variables
$TableRowIndexMaxAutres variables
$TimeFmtVariables de base
$UploadDirVariables pour le téléchargement
$UploadPrefixFmtVariables pour le téléchargement
$UploadUrlFmtVariables pour le téléchargement
$UrlLinkFmtVariables de liens
$VarPagesFmtVariables pour l'internationalisation
$VersionVariables de base
$VersionNumVariables de base
$WikiStyleVariables de mise en page
$WikiTitleVariables de mise en page
$WikiWordCountVariables de liens
$WikiWordCountMaxVariables de liens
$WikiWordPatternVariables de base

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

See Also

Categories:

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