List of documented PHP 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:
- Basic Variables - core variables
- Debug Variables - variables useful for debugging
- Edit Variables - variables used when editing pages
- I18n Variables - variables used for internationalization (i18n)
- Layout Variables - variables that control page layout
- Link Variables - variables that control the display of links in pages
- Other Variables - Variables not yet classified
- Pagelist Variables - variables used with page lists and search results
- Path Variables - variables used to specify various locations on the server
- Security Variables - variables crucial for site security
- Upload Variables - Variables used for uploads/attachments
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 PmWiki to send email messages whenever pages are changed on the wiki site
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 by "$". Therefore all "non WikiWord" variables are shown as link only in the list below, but not elsewhere in PmWiki, as $Author, $Version and $XL.
See Also
- Functions - How some of the functions in pmwiki.php work
Categories: PmWiki Developer
This page may have a more recent version on pmwiki.org: PmWiki:Variables, and a talk page: PmWiki:Variables-Talk.