OnDocUnPublished

Event: OnDocUnPublished¶

Called when a Resource is unpublished via the Unpublish 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 the resource is unpublished via the document context menu in the resource tree. If you uncheck the published checkbox while editing a document on the document page itself, nothing happens.

Example¶

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

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

See Also¶

• System Events
• Plugins