Customization API

Much of Suma’s behavior can be customized to suit your website through Suma’s Customization API (Application Programming Interface). This API is documented in the suma_customization-sample.php file that is included with product.  You can download this from here: Suma download.

Note.  To use this mechanism you must rename the file to suma_customization.php.  That is, remove the -sample from the filename.  The reason for this is so that any edits you make to the file do not get overwritten next time you upgrade Suma.

Each function definition within the file is documented, explaining under what conditions Suma invokes the function, what parameters are supplied by Suma, and what return values Suma expects to see (if any).  In some cases the function already has an sample implementation to illustrate how you might use the function.

The functions can be grouped into the following categories:

  • Messages for Users when they have insufficient privileges
  • Customizing the Subscription / Registration process
  • Notification of Events
  • Customizing the User’s Account