OnBeforePluginFormSave

Last updated Oct 14th, 2026 | Page history | Improve this page | Report an issue

Support the team building MODX with a monthly donation.

The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.

Backers

Budget

$194 per month—let's make that $500!

Learn more

Event: OnBeforePluginFormSave¶

Fires after a form is submitted but before a Plugin is saved in the Manager.

Service: 1 - Parser Service Events
Group: Plugins

Event Parameters¶

Name	Description
mode	Either ‘upd’ or ‘new’, depending on the circumstance.
plugin	A reference to the modPlugin object.
id	The ID of the plugin. Will be 0 for new plugins.
data	The current fields of the Plugin as an array.
object	Alias of `plugin` — a reference to the same object.

Examples¶

<?php
$eventName = $modx->event->name;
switch($eventName) {
    case 'OnBeforePluginFormSave':
        if (!$plugin->get('description')){
            $modx->event->output("You haven't forgotten your head at home, but you forgot about the description! =)");
        }
        break;
}

<?php
$eventName = $modx->event->name;
switch($eventName) {
    case 'OnBeforePluginFormSave':
        // if it's a new plugin
        if ($mode == modSystemEvent::MODE_NEW){
            if ($modx->user->get('id') == 1){
                $modx->event->output("You are not allowed to create new plugins!");
            }
        }
        break;
}

OnBeforePluginFormSave

Event: OnBeforePluginFormSave¶

Event Parameters¶

Examples¶

See Also¶