Plugins

GLPI provides facilities to develop plugins, and there are many plugins that have been already published.

Note

Plugins are designed to add features to GLPI core.

This is a sub-directory in the plugins of GLPI; that would contains all related files.

Generally speaking, there is really a few things you have to do in order to get a plugin working; many considerations are up to you. Anyways, this guide will provide you some guidelines to get a plugins repository as consistent as possible :)

If you want to see more advanced examples of what it is possible to do with plugins, you can take a look at the example plugin source code.

• Guidelines
  • Directories structure
  • Versionning
  • ChangeLog
  • Third party libraries
• Requirements
  • setup.php
  • hook.php
  • Coding standards
• Database
  • Creating and updating tables
  • Deleting tables
• Adding and managing objects
  • Define an object
  • Add a front for my object (CRUD)
• Hooks
  • Standards Hooks
  • Functions hooks
  • Automatic hooks
• Automatic actions
  • Goals
  • Implement an automatic action
  • Register an automatic action
  • Unregister a task
• Massive Actions
• Tips & tricks
  • Add a tab on a core object
  • Add a tab on one of my plugin objects
  • Add several tabs
  • Add an object in dropdowns
• Notification modes
  • Required configuration
  • Settings
  • Event
  • Notification
• Unit Testing
  • Goals
  • Bootstrap
  • Unit test files
  • Running your tests
  • Real examples
  • Further reading
• Plugin development tutorial
  • Prerequisites
  • Start your project
  • Creating an object
  • Common actions on an object
  • Adding to menu and breadcrumb
  • Defining tabs
  • Defining Search options
  • Search engine display preferences
  • Standard events hooks
  • Importing libraries (JavaScript / CSS)
  • Display hooks
  • Adding a configuration page
  • Managing rights
  • Massive actions
  • Notifications
  • Automatic actions
  • Publishing your plugin
  • Miscellaneous
  • REST API