Wiki Manager API

Last modified by Admin on 2021/03/19 01:16

cogXWiki Platform - Wiki Manager - API
Developed by

XWiki Development Team

Active Installs29
0 Votes
LicenseGNU Lesser General Public License 2.1

Installable with the Extension Manager


Since XWiki 5.3, this API was replaced with a new API backing the new Wiki Application, which has the same features but also improve the way we manage subwikis. You should consider using it if you're developping new code or refactoring old code. This API is still available for installation in order to ensure functioning of older applications developped using the old APIs. 

Current features :

  • create empty wiki
  • create wiki from template wiki
  • create wiki from xar package
  • delete wiki

For now HSQLDB, Derby and Postgre are not fully supported. You will have to use MySQL or Oracle databases engines.


The Wiki Manager Plugin depends on the Application Manager Plugin.

This plugin is mostly written to be used by the Wiki Manager Application.


Since 3.3

The plugin way of accessing the API is still valid if you registered the plugin in xwiki.cfg but the recommended way is now


Before 3.3

You can access the plugin API using


Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager).

You can also use the manual method which involves dropping the JAR file and all its dependencies into the WEB-INF/lib folder and restarting XWiki.

You have to make sure the xwiki.virtual property is set to xwiki.virtual=1 in the xwiki.cfg file.

Since 3.3

  • Add the JAR in your container classpath (WEB-INF/lib)

Before 3.3

Follow these steps:

  • Add the JAR in your container classpath (WEB-INF/lib)
  • Edit xwiki.cfg and add the following line to the list of plugins :
           ... ,\
         <plugin package>
  • Restart your container
  • Verify the plugin is properly installed by typing the following in a wiki page :
    $xwiki.<plugin name>.name

    If the installation has been successful, you will see <plugin name>.

The <plugin name> for Wiki Manager is wikimanager.


Dependencies for this extension (org.xwiki.platform:xwiki-platform-wiki-manager-api 5.4.7):

Get Connected