1. This site uses cookies. By continuing to use this site, you are agreeing to our use of cookies. Learn More.

[Docs] Plugin Dependencies - Plugin A requires Plugin B

Discussion in 'Developing Plugins' started by Nick, Jul 16, 2009.

  1. Nick

    Nick Well-Known Member

    With plugins playing such a large role in Hotaru CMS, it's important that they play nicely with each other.

    If your plugin relies on other plugins to function, specify them with "requires: " in the comments section at the top of your plugin file. E.g:

    Code:
    <?php
    /**
     * name: Example plugin
     * description: Doesn't do anything
     * version: 0.1
     * folder: example
     * class: ExamplePlugin
    [B][COLOR=Red] * requires: submit 0.1, users 0.1[/COLOR][/B]
     * hooks: install_plugin, theme_index_top
     */
    
    Important!

    The "requires: " line should be a comma-separated list of plugin_folder *space* plugin_version pairs.

    If your plugin doesn't require any other plugins, don't include "requires: ". An empty "requires: " will generate an error.
     
    Last edited: Jan 6, 2010

Share This Page