Forum GLPI-Project

lordbat

Member

From: Spain

Registered: 2016-02-12

Posts: 158

[Solved] Plugin development docs. Which is the latest?

Hi, I'm starting to develop a custom plugin and i searching for the last docs but i found 2 "readthedocs" about plugin development.
So I don't know which is the latest and compatible to GLPI v10+.

This is the first.
https://glpi-developer-documentation.re … index.html

And that is the second.
https://glpi-plugins.readthedocs.io/en/ … new-plugin

Thank you and regards!

Last edited by lordbat (2024-08-13 12:59:43)

---

You can mark this thread as [Solved] in the subject of your thread. (This is only available edit of the first post.) It is good for users who help others to quickly see which post is still open.
############################################################

Kaya84

Member

Registered: 2019-06-13

Posts: 217

Re: [Solved] Plugin development docs. Which is the latest?

One is for GLPI Developmente.
Second is for Plugin development

You need both.

And this is the empty plugin: https://github.com/pluginsGLPI/example

lordbat

Member

From: Spain

Registered: 2016-02-12

Posts: 158

Re: [Solved] Plugin development docs. Which is the latest?

One is for GLPI Developmente.
Second is for Plugin development

You need both.

And this is the empty plugin: https://github.com/pluginsGLPI/example

Thx for the response.... i added wrong the first link (now is edited) where both have plugin dev section but different approach.

Anyway thx for the suggestion

---

You can mark this thread as [Solved] in the subject of your thread. (This is only available edit of the first post.) It is good for users who help others to quickly see which post is still open.
############################################################

cconard96

Moderator

Registered: 2018-07-31

Posts: 2,809

Website

Re: [Solved] Plugin development docs. Which is the latest?

The documentation from:
https://glpi-plugins.readthedocs.io/

Is more to get started adapting the empty (not the example) plugin project to make it your own. It really doesn't have many useful details.
The section in the main GLPI Development documentation is what you are going to want to refer to.

The "example" plugin is also not useful as a starting point. It can be used as a reference if you need help understanding how plugin hooks or something else are implemented, but most of the code in it doesn't really do anything.
Also, some of the code in the example plugin is very old and doesn't apply to the current GLPI version anymore.
A better reference may be to find a plugin that does something similar to what you want to do and look at its source code. Most GLPI plugins are free and open source.

https://plugins.glpi-project.org/#/

---

GLPI Collaborator and Plugin Developer.
My non-English comments are automated translations. Sorry for any confusion that causes.
Mes commentaires non anglais sont des traductions automatiques. Désolé pour toute confusion qui cause.
Mis comentarios que no están en inglés son traducciones automáticas. Perdón por cualquier confusión que cause.

lordbat

Member

From: Spain

Registered: 2016-02-12

Posts: 158

Re: [Solved] Plugin development docs. Which is the latest?

The documentation from:
https://glpi-plugins.readthedocs.io/

Is more to get started adapting the empty (not the example) plugin project to make it your own. It really doesn't have many useful details.
The section in the main GLPI Development documentation is what you are going to want to refer to.

The "example" plugin is also not useful as a starting point. It can be used as a reference if you need help understanding how plugin hooks or something else are implemented, but most of the code in it doesn't really do anything.
Also, some of the code in the example plugin is very old and doesn't apply to the current GLPI version anymore.
A better reference may be to find a plugin that does something similar to what you want to do and look at its source code. Most GLPI plugins are free and open source.

https://plugins.glpi-project.org/#/

Thank you cconard for the explanation, maybe the docs needs an update in the future. Well i will see the other plugins to guide me.

---

You can mark this thread as [Solved] in the subject of your thread. (This is only available edit of the first post.) It is good for users who help others to quickly see which post is still open.
############################################################