OnDocPublished

Event: OnDocPublished¶

Called when a Resource is published via the Publish context menu.

• Service: 5 - Template Service Events
• Group: None

Event Parameters¶

Important! Before using this event, you need to know¶

The event fires only when a resource is published via the document context menu in the resource tree. If you check the published checkbox while editing a document on the page of the document itself, nothing happens.

Example¶

Such a plugin will display an array of the published resource in the "Error log", and a success message on the screen:

<?php
$eventName = $modx->event->name;
switch($eventName) {
    case 'OnDocPublished':
        $response = array(
        	'success' => false,
        	'message' => 'The publication was successful!',
        	'data' => array(),
        );
        echo $modx->toJSON($response);
        exit; 
        $modx->log(modX::LOG_LEVEL_ERROR, print_r($resource->toArray(),true));
        break;
}

See Also¶

• System Events
• Plugins