PhpWiki lets you extend it with new functionality via a plugin
mechanism. In short, you extend a PHP class we provide and customize
it to print out the content you want. For more information see
Help:WikiPlugin, Help:HelloWorldPlugin, and view the source of the files in
lib/plugin.
If there is no example page for the plugin, or you need more information, the best place to go is the source of the plugin. Under your wiki's root directory, the folder lib/plugin contains all the PHP files for the plugins.
External Requirements
Some plugins require correctly configured PLUGIN_CACHED and external libraries not provided with PhpWiki or PHP, such as
- PHP with GD support for the Help:text2pngPlugin,
LaTeX2HTML for the Help:TexToPngPlugin and Help:TeX2pngPlugin,
graphviz for the Help:GraphVizPlugin and Help:VisualWikiPlugin,- ploticus for the Help:PloticusPlugin,
- phpweather for the Help:PhpWeatherPlugin,
- highlight for the Help:SyntaxHighlighterPlugin,
- a browser with <iframe> support for the Help:TranscludePlugin,
- USE_DB_SESSION = true (default for the peardb, adodb or dba backends) for the Help:WhoIsOnline plugin,
- --with-xml support (with expat or libxml2) for the Help:RssFeedPlugin (ProjectSummary, RecentReleases) and HtmlParser? support (ImportHtml, HtmlAreaEditing),
- PHP Mail functionality (php.ini: SMTP + sendmail_from on Windows or sendmail_path) for email
PhpWiki:PageChangeNotifications and ModeratedPage's,
- a Google license key for the Help:GooglePlugin,
- optionally an external recommender engine (none yet, php only so far) and the wikilens theme for the RateIt plugin,
- optionally apache/mod_log_{my}sql for fast, external log analysis if ACCESS_LOG_SQL=1 (Referer, Abuse Prevention).
See lib/Request.php and http://www.outoforder.cc/projects/apache/mod_log_sql/
Description: Provides a list of plugins on this wiki.
Plugins
| Plugin | Version | Description | Arguments |
| AllPages | 1.37 | List all pages in this wiki. | info= exclude= author= owner= creator= sortby= limit=0 paging=auto cols=1 azhead=0 comma=0 commasep= ordered= linkmore= nopage= noheader= include_empty= debug= |
| AllUsers | 1.18 | List all once authenticated users. | info=pagename exclude= author= owner= creator= sortby= limit=0 paging=auto cols=1 azhead=0 comma=0 commasep= ordered= linkmore= nopage= noheader= include_empty=1 debug= |
| AnalyseAccessLogSql | 1.2 | Show summary information from the access log table. | mode=referring_domains caption= local_referrers=true period= count=0 |
| AppendText | 1.7 | Append text to any page in this wiki. | page=[pagename] s= before= after= redirect= |
| AsciiMath | 1.2 | Render ASCII Math as MathML | |
| AsciiSVG | 1.2 | Render inline ASCII SVG | width=200 height=200 script= onmousemove= |
| AuthorHistory | 1.6 | List all page revisions edited by one user with diff links, or show a PageHistory-like list of a single page for only one user. | exclude= noheader= includeminor= includedeleted= author=root page=[pagename] info=version,minor,author,summary,mtime |
| BackLinks | 1.35 | List all pages which link to [pagename]. | info=pagename exclude= author= owner= creator= sortby= limit=0 paging=auto cols=1 azhead=0 comma=0 commasep= ordered= linkmore= nopage= include_self= noheader= page=[pagename] |
| BoxRight | 1.1 | A simple plugin for <div class=boxright> with wikimarkup | description='A simple plugin for <div class=boxright> with wikimarkup' |
| CacheTest | 1.2 | This is a simple example using WikiPluginCached. | text='This is a simple example using WikiPluginCached.' font=3 type=png |
| CategoryPage | 1.3 | Create a Wiki page. | exclude= pagename=[pagename] plural= singular= self_on_create=1 showbuds= |
| Comment | 1.2 | Embed hidden comments in WikiPages. | |
| CreateBib | 1.1 | Automatically create a Bibtex file from linked pages | pagename=[pagename] |
| CreatePage | 1.11 | Create a Wiki page by the provided name. | s= initial_content= template= vars= overwrite= |
| CreateToc | 1.35 | Automatically link headers at the top | pagename=[pagename] headers=!!!,!!,! noheader=0 position=right with_toclink=0 jshide=0 extracollapse=1 liststyle=dl indentstr= with_counter=0 |
| DeadEndPages | 1.10 | List pages which are not linked to by any other page. | noheader= include_empty= exclude= info= sortby= limit=0 paging=auto |
| Diff | 1.4 | Display differences between revisions | pagename=[pagename] name=World versions= version= previous=major |
| EditMetaData | 1.14 | Edit metadata for [pagename] | page=[pagename] |
| ExternalSearch | 1.13 | Redirects to an external web site based on form input | s= formsize=30 url= name= useimage= width= height= debug= button_position=right |
| FileInfo | 1.6 | Display file information like version,size,date,... of uploaded files. | file= display= format= quiet= |
| FoafViewer | 1.4 | Parse an RDF FOAF file and extract information to render as HTML | foaf= original= |
| FrameInclude | 1.10 | Displays a url in a seperate frame inside our body. Only one frame allowed. | src= page= name=content title= rows=18%,*,15% cols=20%,* frameborder=1 marginwidth= marginheight= noresize= scrolling=auto |
| FullTextSearch | 1.27 | Search the content of all pages in this wiki. | info=pagename exclude= author= owner= creator= sortby= limit= paging=auto cols=1 azhead=0 comma=0 commasep= ordered= linkmore= nopage= s= hilight=1 case_exact= regex=auto noheader= quiet= |
| FuzzyPages | 1.12 | Search for page titles similar to [pagename]. | s= debug= |
| GoTo | n/a | Go to or create page. | size=32 |
| GoogleMaps | 1.3 | Displays a marker with further infos (when clicking) on given coordinates | Longitude= Latitude= ZoomFactor=5 Marker=1 InfoText= MapType=Hybrid SmallMapControl= width=500px height=400px |
| GooglePlugin | 1.5 | Make use of the Google API | q= mode=search startIndex=1 maxResults=10 formsize=30 |
| GraphViz | 1.9 | GraphViz image or imagemap creation of directed graphs | imgtype=png alt= pages= exclude= help= debug= |
| HelloWorld | 1.13 | Simple Sample Plugin | salutation=Hello, name=World |
| HtmlConverter | n/a | Convert HTML markup into wiki markup. (Version 0.5) | |
| Imdb | 1.1 | Query a local imdb database | query= template= where= title= name= sortby= limit= |
| IncludePage | 1.28 | Include text from another wiki page. | page= rev= quiet= words= lines= section= sectionhead= |
| IncludePages | 1.2 | Include multiple pages. | pages= exclude= page= rev= quiet= words= lines= section= sectionhead= |
| IncludeSiteMap | 1.15 | Include recursively all linked pages starting at | exclude= include_self=0 noheader=0 page=[pagename] description='Include recursively all linked pages starting at ' reclimit=2 info= direction=back firstreversed= excludeunknown=1 includepages=words=50 |
| InterWikiSearch | 1.9 | Perform searches on InterWiki sites listed in InterWikiMap. | s= formsize=30 |
| JabberPresence | 1.3 | Simple jabber presence plugin | scripturl=http://edgar.netflint.net/status.php jid=root@jabber.com type=image iconset=gabber |
| LdapSearch | 1.5 | Search an LDAP directory | host= port=389 basedn= filter=(cn=*) attributes= user= password= options= |
| LikePages | 1.22 | List page names which share an initial or final title word with '[pagename]'. | info=pagename exclude= author= owner= creator= sortby= limit=0 paging=auto cols=1 azhead=0 comma=0 commasep= ordered= linkmore= nopage= page=[pagename] prefix= suffix= noheader= |
| LinkDatabase | 1.8 | List all pages with all links in various formats for some Java Visualization tools | info= exclude= author= owner= creator= sortby= limit=0 paging=auto cols=1 azhead=0 comma=0 commasep= ordered= linkmore= nopage= format=html noheader= include_empty= exclude_from= |
| LinkSearch | 1.1 | Search page and link names | info=pagename exclude= author= owner= creator= sortby= limit=0 paging=auto cols=1 azhead=0 comma=0 commasep= ordered= linkmore= nopage= s= page=* direction=out case_exact= regex=auto noform= noheader= |
| ListPages | 1.10 | List pages that are explicitly given as the pages argument. | info=pagename exclude= author= owner= creator= sortby= limit=0 paging=auto cols=1 azhead=0 comma=0 commasep= ordered= linkmore= nopage= pages= dimension=0 |
| ListRelations | 1.1 | Display the list of all defined relations and optionnally attributes in this entrire wiki | info=pagename exclude= author= owner= creator= sortby= limit=0 paging=auto cols=1 azhead=0 comma=0 commasep= ordered= linkmore= nopage= mode=relations |
| ListSubpages | 1.6 | Lists the names of all SubPages of the current page. | info= exclude= author= owner= creator= sortby= limit=0 paging=auto cols=1 azhead=0 comma=0 commasep= ordered= linkmore= nopage= noheader= basepage= maxpages= |
| ModeratedPage | 1.6 | Support moderated pages | page=[pagename] moderators= require_level= require_access=edit,remove,change id= pass= |
| MostPopular | 1.32 | List the most popular pages. | info= exclude= author= owner= creator= sortby=-hits limit=20 paging=auto cols=1 azhead=0 comma=0 commasep= ordered= linkmore= nopage= pagename=[pagename] noheader=0 |
| NewPagesPerUser | 1.1 | List all new pages per month per user | userid= month=0 since=0 until=0 comments=0 links=1 debug=0 |
| NoCache | 1.3 | Don't cache this page. | nocache=1 |
| OldStyleTable | 1.11 | Layout tables using the old markup style. | caption= cellpadding=1 cellspacing=1 border=1 summary= |
| OrphanedPages | 1.10 | List pages which are not linked to by any other page. | noheader= include_empty= exclude= info= sortby= limit=0 paging=auto |
| PageDump | 1.20 | View a single page dump online. | s= page=[pagename] format= download= |
| PageGroup | 1.9 | PageGroup for [pagename] | parent= rev= section=Contents label= loop= |
| PageHistory | 1.32 | List PageHistory for [pagename] | days= show_minor=1 show_major=1 limit= page=[pagename] format= |
| PageInfo | 1.5 | Show extra page Info and statistics for [pagename]. | page=[pagename] version=[version] |
| PageTrail | 1.9 | PageTrail Plugin | numberlinks=5 invisible= duplicates= |
| PasswordReset | 1.4 | PasswordReset | user= |
| PhotoAlbum | 1.15 | Displays a set of photos listed in a text file with optional descriptions | src= url= mode=normal numcols=3 showdesc=both link=1 attrib= bgcolor=#eae8e8 hlcolor=#c0c0ff align=center height=auto width=auto cellwidth=image tablewidth= p= h= duration=6 thumbswidth=80 |
| PhpHighlight | 1.9 | PHP syntax highlighting | wrap=1 string=#DD0000 comment=#FF8000 keyword=#007700 bg=#FFFFFF default=#0000BB html=#000000 |
| PhpWeather | 1.12 | The PhpWeather plugin provides weather reports from the Internet. | icao=EKAH cc=DK language=en menu= units=both_metric |
| Ploticus | 1.14 | Ploticus image creation | device=png -prefab= -csmap= data= alt= help= |
| PluginManager | 1.20 | Description: Provides a list of plugins on this wiki. | info=args |
| PopUp | 1.1 | Used to create a clickable popup link. | link=HomePage title= text= width=500 height=400 resizable=no scrollbars=no toolbar=no location=no directories=no status=no menubar=no copyhistory=no close=no |
| PopularNearby | 1.5 | List the most popular pages nearby. | pagename=[pagename] mode=nearby limit=5 noheader=0 |
| PopularTags | 1.2 | List the most popular tags. | pagename=[pagename] limit=10 mincount=5 noheader=0 |
| PreferenceApp | 1.4 | Analyzes preferences based on voting budget and ratings. | category= lockedBudget= pageTextLabel= group= roundCalc=true neutralRating=3 declareBudget=true |
| PrevNext | 1.4 | Easy navigation buttons for [pagename] | prev= next= up= contents= index= first= last= order= style=button class=wikiaction |
| RandomPage | 1.13 | Displays a list of randomly chosen pages or redirects to a random page. | info= exclude=RandomPage,HomePage,AllPages,RecentChanges,RecentEdits,FullRecentChanges author= owner= creator= sortby= limit=0 paging=auto cols=1 azhead=0 comma=0 commasep= ordered= linkmore= nopage= numpages=20 pages= redirect= hidename= |
| RateIt | 1.22 | Rating system. Store user ratings per page | pagename=[pagename] version= id=rateit imgPrefix= dimension= small= show= mode= |
| RawHtml | 1.11 | A plugin to provide for raw HTML within wiki pages. | description='A plugin to provide for raw HTML within wiki pages.' |
| RdfDefinition | 1.6 | Define the RDF vocabulary for a wiki subset. | pages= |
| RecentChanges | 1.119 | RecentChanges | days=2 show_minor= show_major=1 show_all= show_deleted=sometimes only_new= author= owner= limit= format= daylist= difflinks=1 historylinks= caption= |
| RecentChangesCached | 1.4 | Caches output of RecentChanges called with default arguments. | days=2 show_minor= show_major=1 show_all= show_deleted=sometimes only_new= author= owner= limit= format= daylist= difflinks=1 historylinks= caption= |
| RecentComments | 1.3 | RecentComments | days=2 show_minor= show_major=1 show_all=1 show_deleted=sometimes only_new= author= owner= limit= format= daylist= difflinks=1 historylinks= caption='Recent Comments' |
| RecentEdits | 1.1 | RecentEdits | days=2 show_minor=1 show_major=1 show_all=1 show_deleted=sometimes only_new= author= owner= limit= format= daylist= difflinks=1 historylinks= caption= |
| RecentReferrers | 1.2 | RecentReferrers | info=pagename exclude= author= owner= creator= sortby= limit=15 paging=auto cols=1 azhead=0 comma=0 commasep= ordered= linkmore= nopage= noheader= debug= |
| RedirectTo | 1.13 | Redirects to another url or page. | href= page= |
| RelatedChanges | 1.5 | RecentEdits | days=2 show_minor=1 show_major=1 show_all=1 show_deleted=sometimes only_new= author= owner= limit= format= daylist= difflinks=1 historylinks= caption='Related Changes' page=[pagename] |
| RichTable | 1.7 | Layout tables using a very rich markup style. | |
| RssFeed | 1.10 | Simple RSS Feed aggregator Plugin | feed= description= url= maxitem=0 debug= |
| SearchHighlight | 1.3 | Hilight referred search terms. | noheader= hits= s= case_exact= regex= |
| SemanticRelations | 1.4 | Display the list of relations and attributes on this page. | page=[pagename] relations= attributes= units= noheader= nohelp= |
| SemanticSearch | 1.4 | Search relations and attributes | info= exclude= author= owner= creator= sortby= limit=0 paging=auto cols=1 azhead=0 comma=0 commasep= ordered= linkmore= nopage= s=* page=* relation= attribute= attr_op=:= units= case_exact= regex=auto noform= noheader= |
| SiteMap | 1.15 | Recursively get BackLinks or links | exclude= include_self=0 noheader=0 page=[pagename] description='Recursively get BackLinks or links' reclimit=4 info= direction=back firstreversed= excludeunknown=1 includepages= |
| SpellCheck | 1.2 | Check the spelling of a page and make suggestions | pagename=[] |
| SqlResult | 1.8 | Display arbitrary SQL result tables | alias= ordered= template= where= sortby= limit=0,50 |
| SyncWiki | 1.3 | Synchronize pages with external PhpWiki | url= noimport=0 noexport=0 noupload=0 label=SyncWiki passwd= sid= |
| SyntaxHighlighter | 1.7 | Source code syntax highlighter (via http://www.andre-simon.de) | syntax= style= color= number=0 wrap=0 |
| SystemInfo | 1.23 | Provides access to PhpWiki's lower level system information. | description='Provides access to PhpWiki's lower level system information.' |
| TeX2png | 1.4 | Convert Tex mathematicals expressions to cached png files. This is for small text | text='$$(a + b)^2 = a^2 + 2 ab + b^2$$' |
| Template | 1.9 | Parametrized page inclusion. | page= vars= rev= section= sectionhead= |
| TexToPng | 1.5 | Converts TeX to an image. May be used to embed formulas in PhpWiki. | tex= magstep=3 img=png subslash=off antialias=on transparent=off center=off |
| TitleSearch | 1.29 | Search the titles of all pages in this wiki. | info= exclude= author= owner= creator= sortby= limit=0 paging=auto cols=1 azhead=0 comma=0 commasep= ordered= linkmore= nopage= s= auto_redirect= noheader= case_exact= regex=auto format= |
| Transclude | 1.10 | Include an external web page within the body of a wiki page. | src= height=450 |
| TranslateText | 1.5 | Define a translation for a specified text | lang= pagename=[pagename] translate= |
| UnfoldSubpages | 1.21 | Includes the content of all SubPages of the current page. | info=pagename exclude= author= owner= creator= sortby= limit=0 paging=auto cols=1 azhead=0 comma=0 commasep= ordered= linkmore= nopage= pagename=[pagename] quiet= maxpages= sections= smalltitle= words= lines= bytes= section= sectionhead= |
| UpLoad | n/a | Upload files to the local InterWiki Upload:<filename> | logfile=phpwiki-upload.log autolink=1 page=[pagename] size=50 mode=actionpage |
| UserPreferences | 1.37 | UserPreferences | userid= passwd= autologin= email= notifyPages= theme=default lang=en editWidth=80 noLinkIcons= editHeight=22 timeOffset=0 relativeDates= googleLink= doubleClickEdit= |
| UserRatings | 1.5 | List the user's ratings. | dimension=0 userids= pageids= category= pagename=[pagename] exclude= limit=0 noheader=0 userPage= nobuds= info=pagename |
| VisualWiki | 1.21 | Visualizes the Wiki structure in a graph using the 'dot' commandline tool from graphviz. | imgtype=png width= height= colorby=age fillnodes=off label=name shape=ellipse large_nb=5 recent_nb=5 refined_nb=15 backlink_nb=5 neighbour_list= exclude_list= include_list= fontsize=9 debug= help= |
| WantedPages | 1.17 | Lists referenced page names which do not exist yet. | info=pagename exclude= author= owner= creator= sortby= limit=100 paging=auto cols=1 azhead=0 comma=0 commasep= ordered= linkmore= nopage= page=[pagename] withlinks=0 noheader= exclude_from=PgsrcTranslation,InterWikiMap |
| WatchPage | 1.2 | WatchPage | page=[pagename] mode=add |
| WhoIsOnline | 1.11 | Show summary information of the current user sessions. | mode=summary pagename=[pagename] allow_detail= dispose_admin= |
| WikiAdminChmod | 1.14 | Set individual page permissions. | info=pagename,perm,mtime,author exclude= author= owner= creator= sortby= limit=0 paging=auto cols=1 azhead=0 comma=0 commasep= ordered= linkmore= nopage= s= perm= |
| WikiAdminChown | 1.8 | Chown selected pages. | info=pagename,owner,mtime exclude= author= owner= creator= sortby= limit=0 paging=auto cols=1 azhead=0 comma=0 commasep= ordered= linkmore= nopage= s= user= |
| WikiAdminMarkup | 1.1 | Change the markup type of selected pages. | info=pagename,markup,mtime exclude= author= owner= creator= sortby= limit=0 paging=auto cols=1 azhead=0 comma=0 commasep= ordered= linkmore= nopage= s= markup=2 |
| WikiAdminRemove | 1.30 | Permanently remove all selected pages. | info=most exclude= author= owner= creator= sortby= limit=0 paging=auto cols=1 azhead=0 comma=0 commasep= ordered= linkmore= nopage= s= min_age=0 max_age=31 |
| WikiAdminRename | 1.26 | Rename selected pages | info=pagename,mtime exclude= author= owner= creator= sortby= limit=0 paging=auto cols=1 azhead=0 comma=0 commasep= ordered= linkmore= nopage= s= updatelinks=0 |
| WikiAdminSearchReplace | 1.19 | Search and replace text in selected wiki pages. | info=some exclude= author= owner= creator= sortby= limit=0 paging=auto cols=1 azhead=0 comma=0 commasep= ordered= linkmore= nopage= s= |
| WikiAdminSelect | 1.24 | Allows selection of multiple pages which get passed to other WikiAdmin plugins. | s= author= owner= creator= only= exclude= info=most sortby=pagename limit=150 debug= |
| WikiAdminSetAcl | 1.23 | Set individual page permissions. | info=pagename,perm,mtime,owner,author exclude= author= owner= creator= sortby= limit=0 paging=auto cols=1 azhead=0 comma=0 commasep= ordered= linkmore= nopage= p=[] s= |
| WikiAdminUtils | 1.24 | Miscellaneous utility functions for the Administrator. | action= label= |
| WikiBlog | 1.27 | Show and add blogs for [pagename] | pagename=[pagename] order=normal mode=show,add noheader= |
| WikiForm | 1.16 | WikiForm | action=upload default= buttontext= overwrite= size=50 |
| WikiFormRich | 1.19 | Provide generic WikiForm input buttons | action= method=post class=wikiaction buttontext= cancel= nobr= |
| WikiForum | 1.4 | Handles threaded topics with comments/news and provide a input form | pagename=[pagename] order=normal mode=show,add info= noheader= |
| WikiPoll | 1.10 | Enable configurable polls | page=[pagename] admin= require_all=1 require_least=0 |
| YouTube | 1.2 | Embed YouTube videos | v= browse= time= category= language= index=0 style=inline size=medium autoplay=0 width=425 height=350 |
| _AuthInfo | 1.20 | Display general and user specific auth information. | userid= |
| _BackendInfo | 1.28 | Get debugging information for [pagename]. | page=[pagename] notallversions=0 |
| _GroupInfo | 1.1 | Show Group Information | |
| _PreferencesInfo | 1.3 | Get preferences information for current user [userid]. | page=[pagename] userid=[userid] |
| _Retransform | 1.1 | Show a markup retransformation of page [pagename]. | page=[pagename] |
| _WikiTranslation | 1.17 | Show translations of various words or pages | info=pagename exclude= author= owner= creator= sortby= limit=0 paging=auto cols=1 azhead=0 comma=0 commasep= ordered= linkmore= nopage= languages= string= page= what=pages match=* from_lang= include_empty= nolinks= noT= debug= |
| text2png | 1.15 | Convert text into a png image using GD. | text='text2png testtext' lang=en_US.UTF-8 _force=0 fontsize=18 with_shadow=1 fontcolor=#000000 shadowcolor=#AFAFAF backcolor=#ffffff |
