AvailableActions
Page actions are applied to wiki pages, as a query string appended to the URL. Security can be applied to all default actions, and script actions with one exception, but not diag actions, through the use of passwords.
Also documented are all other URL queries.
NOTE: All actions will be disabled if the following is set:
$EnableActions = 0; include('pmwiki.php');
This will initialize PmWiki (along with any configuration/customizations
that are being made, e.g. from local/config.php
), but won't actually
perform any actions. The caller can then call the desired action
or other functions as desired. This is available from Version 2.2.0-beta22 on up.
PmWiki Actions
See also site page actions.
- ?action=attr
- displays dialog for setting/changing password of the specified page or group of pages, see passwords, see also
$EnablePostAttrClearSession
if you do not want to have the session cleared after validating change General use of passwords and login
- ?action=browse
- display the specified page (default action if no
?action=
is present)
- ?action=crypt
- displays a form for generating hashed passwords out of clear text for usage in your config.php
- ?action=diff
- show a change history of the specified page, see page history History of previous edits to a page
- ?action=download&upname=file.ext
- retrieve the page's attachment named file.ext, see
$EnableDirectDownload
- ?action=edit
- edit the specified page, see basic editing PmWiki's basic edit syntax
- ?action=login
- prompt visitor for username/password, by default using Site.AuthForm
- ?action=logout
- remove author, password, and login information
- ?action=print
- display the specified page using the skin specified by
$ActionSkin
['print']
- ?action=refcount
- bring up the reference count form, which allows the user to generate a list of links (all, missing, existing or orphaned) in or from specified groups. See Ref Count Link references counts on pages . Part of the core distribution but must be enabled by the administrator.
- ?action=search
- displays searchbox on current page, see search Targeting and customizing search results
- ?action=search&q=searchterm
- performs search with searchterm and displays results on current page
- ?action=search&q=link=pagename
- performs backlinks search with pagename and displays results on current page
- ?action=source
- show page source (plain text only)
- ?action=source&highlight=1
- show page source highlighted (HTML output)
- ?action=template
- creates a link that will open the NewPage using the contents of OldPage, see Cookbook:Edit Templates Specify a wiki page or pages to use as a template when a new page is created.
- ?action=atom
- ?action=rdf
- ?action=rss
- ?action=dc
- If web feeds are enabled, returns a syndication feed based on the contents of the page or other options provided by the url, see web feeds Web feed notification of changes
- ?action=upload
- display a form to upload an attachment for the current group, see uploads Uploading and linking to attachments
Query string parameters
- ?from=page name
- use when a page is redirected
- ?n=page name
- display page
- ?setprefs=SomeGroup.CustomPreferences
- sets cookie to custom preferences page. See site preferences Customisable browser setting preferences: Access keys, edit form
Actions enabled by $EnableDiag
The following actions are available only if you set
in your configuration file. They can be used for debugging and should not be set in a production environment.
$EnableDiag
= 1;
- ?action=ruleset
- displays a list of all markups in 4 columns:
- column 1 = markup-name (1. parameter of
markup()
) - column 2 = when will rule apply (2. parameter of
markup()
) - column 3 = PmWiki's internal sort key (derived from #2)
- column 4 = Debug backtrace information for potentially incompatible rules (filename, line number, pattern)
- column 1 = markup-name (1. parameter of
?action=ruleset
gives you, apply the Cookbook:MarkupRulesetDebugging recipe: it can also show the pattern and the replacement strings.
- doesn't make use of PmWiki's authorization mechanisms.
- ?action=phpinfo
- displays the output of
phpinfo()
and exits. No page will be processed- doesn't make use of PmWiki's authorization mechanisms.
- ?action=diag
- displays a dump of all global vars and exits. No page will be processed
- doesn't make use of PmWiki's authorization mechanisms.
Actions enabled by PmWiki Scripts
- ?action=analyze
- see Site Analyzer and Analyze Results
- ?action=approvesites
- see Url approvals Require approval of Url links
- doesn't make use of PmWiki's authorization mechanisms.
Actions enabled by recipes
(more information about Custom Actions)
- ?action=admin
- see Cookbook:UserAuth2 A user-based permission granting and authentication module
- ?action=attachman
- see Cookbook:Attachman Attachman[ager] shows attaches as a rich sortable table, works also via AJAX
- ?action=backup
- see Cookbook:BackupPages Automatically back up the wiki.d directory to a .zip file
- ?action=clearsky
- see Cookbook:SearchCloud Creates a list of search terms used on a PmWiki site.
- ?action=cm-dependencies
- see Cookbook:CodeMirror An enhanced page editor for PmWiki
- ?action=comment
- see Cookbook:CommentBox Adds a simple form to post comments
- ?action=comments
- see Cookbook:Comments Comment addon - comments in separate files
- ?action=comment-rss
- see Cookbook:CommentDb Comment recipe - with pagination and RSS feed
- ?action=convert
- see Cookbook:ROEPatterns Replace On Edit
- ?action=converttable
- Cookbook:ConvertTable Convert table action
- ?action=copy
- see Cookbook:MovePage Move and copy wiki pages
- ?action=csv
- see Cookbook:CSVAction Adds a ?action=csv capability to pmwiki to output tables as a CSV
- ?action=downloaddeleted
- ?action=delattach
- ?action=deldelattach
- ?action=fileinfo
- ?action=thumbnail
- ?action=undelattach
- Cookbook:Attachtable Actions to rename, delete & restore deleted attachments, as well as an attachlist replacement to use those actions, show file types and list attachment references.
- ?action=delete
- see Cookbook:DeletePage Use a "delete" action and a separate password for deleting pages
- ?action=discuss
- see Cookbook:DiscussionTab Provide a skin with a "discussion" tab and "article" tab, etc.
- ?action=downloadman
- see Cookbook:DownloadManager How can I know how many times a file was downloaded from my wiki?
- ?action=expirediff
- see Cookbook:ExpireDiff How to remove a page's history
- ?action=hidediff
- see Cookbook:HideDiff Hide specific edits from page histories
- ?action=hub
- see Cookbook:ExtensionHub Configuration panel for extensions
- ?action=import
- see Cookbook:ImportText Import text files as PmWiki pages
- ?action=lang
- see Cookbook:MultiLanguageViews show language specific content and titles according to user choice
- ?action=setlang
- see Cookbook:MultiLanguageViews show language specific content and titles according to user choice
- ?action=links
- see Cookbook:RenamePage Rename a wiki page from a browser
- ?action=lockflipbox
- see Cookbook:Flipbox Flippable checkboxes and checklists
- ?action=unlockflipbox
- see Cookbook:Flipbox Flippable checkboxes and checklists
- ?action=migr8
- see Cookbook:MigrateUTF8 Convert filenames of PmWiki pages and uploads to UTF-8
- ?action=move
- see Cookbook:MovePage Move and copy wiki pages
- ?action=pageindex
- see Cookbook:ListCategories use categories as tags
- ?action=PageUrl
- see Cookbook:CommentBoxPlus Simple styled form to post comments, plus comment counter
- ?action=pdf
- see Cookbook:GeneratePDF Generate PDF versions of pages (?action=pdf)
- or Cookbook:PmWiki2PDF Generate a PDF; back up all wiki pages in PDF format
- ?action=postupload2
- see Cookbook:UploadForm Alternative file upload form using
(:input file:)
- ?action=ppdonate
- see Cookbook:PPDonate - Create links to accept donations via PayPal
- ?action=publish
- see Cookbook:PublishPDF Typesets wiki page collections into PDF (finalist: New Zealand open source awards 2008)
- ?action=purgeqns
- see Cookbook:ASCIIMath Display MathML rendered ascii formula into PmWiki 2.x pages
- ?action=pwchange
- see Cookbook:UserAuth2 A user-based permission granting and authentication module
- ?action=imgtpl
- (the imgtpl action is called automatically and should not be called by a link in a wiki page)
- ?action=createthumb
- (the createthumb action is called automatically and should not be called by a link in a wiki page)
- ?action=mini
- (this action is called automatically and should not be called by a link in a wiki page)
- ?action=purgethumbs
- see Cookbook:ThumbList A thumbnail picture gallery for PmWiki
see Cookbook:Mini Simple, lightweight, un-bloated gallery with thumbnail generator - ?action=recipecheck
- see Cookbook:RecipeCheck Check for new versions of recipes on pmwiki.org
- ?action=regen
- see Cookbook:PageRegenerate Make PmWiki regenerate a page, as if someone had done an edit+save sequence.
- ?action=reindex
- see Cookbook:Reindex Force re-creation of entire .pageindex
- ?action=reindexcat
- See Cookbook:ReindexCategories Update link targets and page index for PmWiki 2.3.0
- ?action=rename
- ?action=links
- see Cookbook:RenamePage Rename a wiki page from a browser
- ?action=rmpi
- see Test.PageIndex This page exists to test and benchmark the page indexing facilities.
- ?action=share
- ?action=unshare
- see Cookbook:SharedPages Share selected pages among several wikis on a common server, as in WikiFarms
- ?action=sitemap
- see Cookbook:GoogleSiteMap Create an XML sitemap in the root of the website which is suitable for submission to Google (and other) search engines.
- ?action=sitemapaddgroups
- ?action=sitemapupdate
- see Cookbook:Sitemapper Adds a dynamically generated sitemap to PmWiki.
- ?action=totalcounter
- see Cookbook:TotalCounter A statistic counter - counts page views, users, languages, browsers, operating systems, referers, locations and web bots
- ?action=trash
- ?action=untrash
- see Cookbook:Trash "safely delete" pages so that they can be restored and listed with pagelists
- ?action=webadmin
- see Cookbook:WebAdmin PHP file manager, works without ftp client
- ?action=zap
- see Cookbook:ZAP The ZAP forms processor handles data and file management, page insertions (forums, blogs), email & newsletters, e-commerce, and more.
Query string parameters enabled by recipes
- ?color=colorscheme
:?setcolor=colorscheme
- ?skintheme=theme
- ?setskintheme=theme
- see Cookbook:ChoiceColorChanger Provide a way of setting persistent skin color and theme choices when using the Choice skin.
- ?skin=skinname
- ?setskin=skinname
- see SkinChange change skin via query or cookie setting
Custom actions
- See CustomActions.
This page may have a more recent version on pmwiki.org: PmWiki:AvailableActions, and a talk page: PmWiki:AvailableActions-Talk.