Docs in progress for ‘QGIS testing’. Visit https://docs.qgis.org/2.18 for QGIS 2.18 docs and translations.

QGIS Plugins

QGIS has been designed with a plugin architecture. This allows many new features and functions to be easily added to the application. Some of the features in QGIS are actually implemented as plugins.

Core and External plugins

QGIS plugins are implemented either as Core Plugins or External Plugins.

Core Plugins are maintained by the QGIS Development Team and are automatically part of every QGIS distribution. They are written in one of two languages: C++ or Python.

Most of External Plugins are currently written in Python. They are stored either in the ‘Official’ QGIS Repository at https://plugins.qgis.org/plugins/ or in external repositories and are maintained by the individual authors. Detailed documentation about the usage, minimum QGIS version, home page, authors,and other important information are provided for the plugins in the Official repository. For other external repositories, documentation might be available with the external plugins themselves. External plugins documentation is not included in this manual.

To install or activate a plugin, go to Plugins menu and select showPluginManager Manage and install plugins….

Installed external python plugins are placed under the ~/(UserProfile)/python/plugins folder where:

  • ~ represents the HOME directory which on win Windows is usually something like C:\Documents and Settings\(user) (on Windows XP or earlier) or C:\Users\(user).
  • and (UserProfile) represents the active profile folder, which for the QGIS default user profile is:
    • nix .local/share/QGIS/QGIS3/profiles/default;
    • win AppData\Roaming\QGIS\QGIS3\profiles\default;
    • osx Library/Application Support/QGIS/QGIS3/profiles/default.

Paths to Custom C++ plugins libraries can also be added under Settings ‣ Options ‣ System.

Note

According to the plugin manager settings, QGIS main interface can display an icon on the right of the status bar to inform you that there are updates for your installed plugins or new plugins available.

The Plugins Dialog

The tabs in the Plugins dialog allow the user to install, uninstall and upgrade plugins in different ways. Each plugin has some metadata displayed in the right panel:

  • information on whether the plugin is experimental
  • description
  • rating vote(s) (you can vote for your preferred plugin!)
  • tags
  • some useful links to the home page, tracker and code repository
  • author(s)
  • version available

At the top of the dialog, a Search function helps you find any plugin using metadata information (author, name, description…). It is available in nearly every tab (except transformSettings Settings).

The Settings tab

The transformSettings Settings tab is the main place you can configure which plugins can be displayed in your application. You can use the following options:

  • checkbox Check for updates on startup. Whenever a new plugin or a plugin update is available, QGIS will inform you ‘every time QGIS starts’, ‘once a day’, ‘every 3 days’, ‘every week’, ‘every 2 weeks’ or ‘every month’.
  • checkbox Show also experimental plugins. QGIS will show you plugins in early stages of development, which are generally unsuitable for production use.
  • checkbox Show also deprecated plugins. Because they use functions that are no longer available in QGIS, these plugins are set deprecated and generally unsuitable for production use. They appear among invalid plugins list.

By default, QGIS provides you with its official plugin repository with the URL https://plugins.qgis.org/plugins/plugins.xml?qgis=3.0 (in case of QGIS 3.0) in the Plugin repositories section. To add external author repositories, click Add… and fill in the Repository Details form with a name and the URL. The URL can be of http:// or file:// protocol type.

The default QGIS repository is an open repository and you don’t need any authentication to access it. You can however deploy your own plugin repository and require an authentication (basic authentication, PKI). You can get more information on QGIS authentication support in Authentication chapter.

If you do not want one or more of the added repositories, they can be disabled from the Settings tab via the Edit… button, or completely removed with the Delete button.

../../../_images/plugins_settings.png

The transformSettings Settings tab

The All tab

In the showPluginManager All tab, all the available plugins are listed, including both core and external plugins. Use Upgrade All to look for new versions of the plugins. Furthermore, you can use Install Plugin if a plugin is listed but not installed, Uninstall Plugin as well as Reinstall Plugin if a plugin is installed. An installed plugin can be temporarily de/activated using the checkbox.

../../../_images/plugins_all.png

The showPluginManager All tab

The Installed tab

In the pluginInstalled Installed tab, you’ll find listed the Core plugins, that you can not uninstall. You can extend this list with external plugins that can be uninstalled and reinstalled any time, using the Uninstall Plugin and Reinstall Plugin buttons. You can Upgrade All the plugins here as well.

../../../_images/plugins_installed.png

The pluginInstalled Installed tab

The Not installed tab

The plugin Not installed tab lists all plugins available that are not installed. You can use the Install Plugin button to implement a plugin into QGIS.

../../../_images/plugins_not_installed.png

The plugin Not installed tab

The Upgradeable and New tabs

The plugin-upgrade Upgradeable and plugin-new New tabs are enabled when new plugins are added to the repository or a new version of an installed plugin is released. If you activated checkbox Show also experimental plugins in the transformSettings Settings menu, those also appear in the list giving you opportunity to early test upcoming tools.

Installation can be done with the Install Plugin, Upgrade Plugin or Upgrade All buttons.

../../../_images/plugins_upgradeable.png

The plugin-upgrade Upgradeable tab

The Invalid tab

The pluginInvalid Invalid tab lists all installed plugins that are currently broken for any reason (missing dependency, errors while loading, incompatible functions with QGIS version…). You can try the Reinstall Plugin button to fix an invalidated plugin but most of the times the fix will be elsewhere (install some libraries, look for another compatible plugin or help to upgrade the broken one).

../../../_images/plugins_invalid.png

The pluginInvalid Invalid tab

The Install from ZIP tab

The installPluginFromZip Install from ZIP tab provides a file selector widget to import plugins in a zipped format, e.g. plugins downloaded directly from their repository.

../../../_images/plugins_install_zip.png

The installPluginFromZip Install from zip tab