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
Coming soon…
PHP Coding Standards and Standard Codes
Coming soon…
Advanced Plug-In Techniques
Coming soon…
Adding Menu Items
Coming soon…
Adding New Sections
Coming soon…
Saving Data To Oempro Database
Coming soon…
Localization
Coming soon…
User Interface Template Tags
Coming soon…
Plug-In Hook Reference
Action Hooks
- Administrator.Login.Pre
- Administrator.Login.Post
- Administrator.Login.Fail
- Administrator.Update.Pre
- Administrator.Update.Post
- Attachment.Delete.Post
- Autoresponder.Create.Post
- Autoresponder.Update.Post
- Autoresponder.Delete.Post
- Campaign.Create.Post
- Campaign.Update.Post
- Campaign.Delete.Post
- Campaign.OnView
- Client.Create.Post
- Client.Login.Post
- Client.Update.Post
- Client.Delete.Post
- CustomField.Create.Post
- CustomField.Update.Post
- CustomField.Delete.Post
- Cron.Bounce
- Cron.Executer
- Cron.FBL
- Cron.General
- Cron.Requests
- Cron.SendEngine
- Cron.Sync
- Cron.TransactionalSend
- Cron.TransactionalSend.AfterDelivery
- Delete.Attachment
- Delete.AutoResponder
- Delete.Campaign
- Delete.Client
- Delete.CustomField
- Delete.Email
- Delete.DesignPreviewJob
- Delete.List
- Delete.MediaLibraryItem
- Delete.PaymentLogs
- Delete.Segments
- Delete.Subscriber.Active
- Delete.Subscriber.Suppressed
- Delete.Subscriber.Segment
- Delete.Subscriber.HardBounced
- Delete.Subscriber.SoftBounced
- Delete.Subscriber.ByID
- Delete.Subscriber.ByEmail
- Delete.Subscriber.NotOptedIn
- Delete.Subscriber.SuppressedSubscribersByID
- Delete.SuppresionList
- Delete.Tag
- Delete.Template
- Delete.Theme
- Delete.TransactionEmail
- Delete.UserGroup
- Delete.User
- Delete.WebserviceIntegration
- Email.Create.Post
- Email.Delete.Pre
- Email.DesignPreview.Create.Post
- Email.DesignPreview.Delete.Post
- Email.Update.Post
- Email.Template.Create.Post
- Email.Template.Update.Post
- Email.Template.Delete.Post
- Email.Send.Stop
- List.Create.Post
- List.Update.Post
- List.Delete.Post
- MediaLibrary.Upload.Post
- User.Login.Post
- User.Update.Post
- User.Create.Post
- User.Delete.Post
- Threshold.SubscriberImport
- Threshold.CampaignRecipients
Filter Hooks
- Email.Send.Before
- Campaign.Email.Send.Before
- Email.Send.EachRecipient
- Campaign.Email.Send.EachRecipient
- PersonalizationTags.List.Campaigns
- PaymentReceipt.Email.PaymentLinks
User Interface Hooks
Menu Hooks
- Admin.Settings
- Admin.TopMenu
- Admin.TopRightMenu
- Client.TopMenu
- Subscriber.TopMenu
- User.TopMenu
- User.ManageMenu
- User.Settings
- User.SettingsMenu
- Campaign.Navigation.Reports
- Campaign.Navigation.ReportOptions
- Campaign.Navigation.Options