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
where is this documented?
