Support and Documentation


Important!
This documentation has been deprecated. We are migrating Oempro help articles to our new help portal. Take a look at more detailed help articles on our new help portal.

Sections:

  1. Creating A Plug-In
    1. Names, Files and Locations
      1. Naming Your Plug-In
      2. Creating Plug-In Directory and Mandatory Files
    2. Creating Main Class Properties and Methods
    3. PHP Coding Standards and Standard Codes
  2. Advanced Plug-In Techniques
    1. Adding Menu Items
    2. Adding New Sections
    3. Saving Data To Oempro Database
    4. Localization
    5. User Interface Template Tags
  • Plug-In Hook Reference
    1. Action Hooks
    2. Filter Hooks
    3. User Interface Hooks
    4. Menu Hooks
    5. System Hooks

    Plug-In Development

    Oempro has a powerful extendability feature that lets you to add new plug-ins into Oempro. You can almost develop any kind of plug-ins for Oempro and extend feature set a lot more based on your needs. SMS sending, reminder, survey, RSS fetching, translator plug-ins are examples to currently available Oempro plug-ins. Click here to browse currently available and officially provided Oempro plug-ins.

    Plug-in development requires basic functionality of Oempro and PHP programming. If you wish to see a new plug-in hook or functionality, do not hesitate to contact us anytime.

    Creating A Plug-In

    In this section, we described how to create a basic plug-in that allows you to add a new feature into Oempro.

    Names, Files and Locations

    Naming Your Plug-In

    We strongly recommend you to choose a unique name that describes what your plug-in does. Click here to browse officially promoted Oempro plug-ins to get an idea.

    Creating Plug-In Directory and Mandatory Files

    Once you decided a name for your plug-in, it's time to create the plug-in directory and put mandatory files inside the directory. For instance, you have named your plug-in "Great Plug-In", the plug-in directory name can be "great_plugin". Create "great_plugin" directory under oempro/plugins/ directory. The path of our new plug-in will be similar to the following one:

    /path/to/oempro/plugins/great_plugin/
    

    Next step is to create the main class file which will perform major operations such as plug-in enable/disable actions. Create a new file under your great_plugin directory. The file name must be example same with the plug-in directory name with a file extension '.php'. In our example, it should be:

    /path/to/oempro/plugins/great_plugin/great_plugin.php
    

    That's all for the beginning.

    Creating Main Class Properties and Methods

    PHP Coding Standards and Standard Codes

    Advanced Plug-In Techniques

    Adding Menu Items

    Adding New Sections

    Saving Data To Oempro Database

    Localization

    User Interface Template Tags

    Plug-In Hook Reference

    Action Hooks

    Filter Hooks

    User Interface Hooks

    Menu Hooks

    System Hooks

    Stay connected!