Difference between revisions of "Plugin Development"
From GeeklogWiki
m (Links to Admins Block, User Settings & User Functions Block) |
|||
| (17 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | Plugin | + | == Overview == |
| + | |||
| + | Geeklog is becoming more and more popular each day and we, the Geeklog developers, are amazed at some of the great hacks people have made to extend their Geeklog installation to fit their own needs. At the same time, the Geeklog development team is continually adding new features that make Geeklog even better. We have realized the need for Geeklog to support two threads of development: core Geeklog code and plugin code. By building in the infrastructure needed to extend Geeklog's functionality through plugins we can make a clean separation between the Geeklog codebase and plugin code so that we can concentrate on making Geeklog's core code better while others can develop plugins so that Geeklog fits their needs. With that said, Geeklog now has a Plugin Application Program Interface (API). | ||
| + | |||
| + | At the highest level, the Geeklog [[Plugin API]] is generic code that is called in strategic places in the Geeklog codebase that allows functions of plugins to be called. This will allow your plugin the following features: | ||
| − | *[[ | + | * Ability for your plugin to be submission-based so that users can submit objects to your plugin. You can then visit the command and control center in Geeklog to moderate the submissions for your plugin. |
| − | + | * Allow your plugin to show up in the [[Admins Block]] and [[User Settings & User Functions Block|User Block]] on each Geeklog page. | |
| − | + | * Allow your plugin to be searched via the Geeklog search page. | |
| − | + | * Allow stats for your plugin to show up on the site statistics page. | |
| − | + | * Allow your plugin the ability to use Geeklog's comment engine. | |
| − | + | * Allow you to use the power of Geeklog's code library (<tt>lib-common.php</tt>) in your own plugin code. | |
| − | + | * Allow you full flexibility on what your plugin does. Geeklog does not dictate your plugin's power. | |
| − | |||
| − | |||
| − | * | ||
| − | |||
| − | * | ||
| − | * | ||
| − | * | ||
| − | * | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | == | + | == Content == |
| + | |||
| + | * Functions for writing Plugins: | ||
| + | ** [[Moderation Functions]] | ||
| + | ** [[Admin and User Menu Functions]] | ||
| + | ** [[Using Geeklog's Improved Search Engine|Search Functions]] | ||
| + | ** [[Integrating the Comment Engine|Comment Functions]] | ||
| + | ** [[Stats Function]] | ||
| + | ** [[Uninstall Function]] | ||
| + | ** [[User Functions]] | ||
| + | ** [[Profile Functions]] | ||
| + | ** [[Misc. Functions]] | ||
| + | * [[Implementing your Admin Interface]] | ||
| + | * [[Preparing your Geeklog Plugin Distribution]] | ||
| + | * [[How To Install A Geeklog Plugin]] | ||
| + | * [[Deliver Your Plugin!]] | ||
| + | |||
| + | |||
| + | == Other Resources == | ||
| − | Geeklog | + | * [[Plugin Developers Handbook]] |
| + | * [[Plugin API]] | ||
| + | * [[Plugin Toolkit]] | ||
| + | * [[Minimal Plugin|Writing A Minimal Geeklog Plugin]] | ||
| + | * [[New Plugin API Functions in Geeklog 1.6.0]] | ||
| − | |||
| − | + | [[Category:Plugin Development]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 11:54, 8 June 2009
Overview
Geeklog is becoming more and more popular each day and we, the Geeklog developers, are amazed at some of the great hacks people have made to extend their Geeklog installation to fit their own needs. At the same time, the Geeklog development team is continually adding new features that make Geeklog even better. We have realized the need for Geeklog to support two threads of development: core Geeklog code and plugin code. By building in the infrastructure needed to extend Geeklog's functionality through plugins we can make a clean separation between the Geeklog codebase and plugin code so that we can concentrate on making Geeklog's core code better while others can develop plugins so that Geeklog fits their needs. With that said, Geeklog now has a Plugin Application Program Interface (API).
At the highest level, the Geeklog Plugin API is generic code that is called in strategic places in the Geeklog codebase that allows functions of plugins to be called. This will allow your plugin the following features:
- Ability for your plugin to be submission-based so that users can submit objects to your plugin. You can then visit the command and control center in Geeklog to moderate the submissions for your plugin.
- Allow your plugin to show up in the Admins Block and User Block on each Geeklog page.
- Allow your plugin to be searched via the Geeklog search page.
- Allow stats for your plugin to show up on the site statistics page.
- Allow your plugin the ability to use Geeklog's comment engine.
- Allow you to use the power of Geeklog's code library (lib-common.php) in your own plugin code.
- Allow you full flexibility on what your plugin does. Geeklog does not dictate your plugin's power.
Content
- Functions for writing Plugins:
- Implementing your Admin Interface
- Preparing your Geeklog Plugin Distribution
- How To Install A Geeklog Plugin
- Deliver Your Plugin!
