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.
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:
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
Note: The automatic variable index and link generation is done by scripts/vardoc.php using
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 (