Pluck variable overview

If you are working on code for pluck (whether this is code for a module, for a theme or you are working on the main code), there are some built in variables you can use. This page lists them in an easy table.

The area listed in the table below, refers to the area in which you can use the variable. We have three areas:

  • admin - you can only use the function in the admin center
  • site - you can use the function on the main site only
  • all - you can use the function in both the admin center and in the site
Variable What does it do? Introduced in version Area
$pluck_version
Contains the version of pluck you're running. 4.6 all
$site_title
Contains the title of the website. 4.6 all
$site_langfile
Contains the language file used (for example en.php). 4.6 all
$site_lang
Contains the two-letter code of the language used (for example en). 4.6 all
$site_email
Contains email adress set by the user. 4.6 all
$site_theme
Contains theme set by the user. 4.6 all
$current_page_filename
Contains the filename of the current page (for example kop1.php). 4.6 site
$current_module_dir
Contains the directory of the module that's being executed (for example blog). 4.6 site
$current_module_page
Contains the module page that's being executed (for example viewalbum). 4.6 site
$page_title
Contains the name of the current page. 4.6 site
 
dev/variables.txt · Last modified: 2008/11/10 19:40 by sander
 
Recent changes RSS feed Creative Commons License Driven by DokuWiki