Step 1. Setting Up Your Plugin

Download the Boilerplate Plugin Files

We've uploaded a set a "skeleton" boilerplate files which can help you get started with your plugin development. You don't need to use every aspect of the boilerplate, but there are some required files. Those files are:

Of course just having these will not do much, so most plugin include functionality classes, administrative dashboard tools, and hooks; this guide will walk you through setting up all of those.

Plugin File Structure

The rough structure of a plugin project looks like this:

custom/PLUGIN_ID
    /admin
        /views
            /popups
        /func
            add.php
            delete.php
            edit.php
        ExtensionObject.php
        package.php
    /conf
        config.php
    /cron
        some_cron_file.php
    /hooks
        member_register.php
    /functions
        internalClass.php
    /options
        pg_pluginName_optionName.php
    /templates
        some_template_name.php
    - install.php
    - uninstall.php
    - callback.php
    - icon.png

Purpose of Each File

Last modified 3 months ago.