Jump to main content Jump to doc navigation

Event: OnChunkFormRender

Fires during the rendering of a form. Useful for rendering HTML straight into the Chunk form.

  • Service: 1 - Parser Service Events
  • Group: Chunks

Event Parameters

Name Description
mode Either 'new' or 'upd', depending on the circumstance.
id The ID of the Chunk. This will be 0 for new chunks.
chunk A reference to the modChunk object. Will be null in new chunks.

Examples of

Such a plugin will add content to the chunk and save it:

<?php
$eventName = $modx->event->name;
switch($eventName) {
    case 'OnChunkFormRender':
        //if we update the existing
        if ($mode == modSystemEvent::MODE_UPD) {
            //added chunk content
            $chunk->setContent('<p>Chunk content</p>');
            //you can immediately save new content
            $chunk->save();
        }
        break;
}

Such a plugin will add content to the chunk if it has no content and will save it:

<?php
$eventName = $modx->event->name;
switch($eventName) {
    case 'OnChunkFormRender':
        //if we update the existing
        if ($mode == modSystemEvent::MODE_UPD) {
            //we take the content of the chunk
            $content = $chunk->getContent();
            // if there is no content, push in a new one
            if (!$content){
                $chunk->setContent('<p>New content</p>');
                //you can immediately save new content
                $chunk->save();
            }
        }
        break;
}

Such a plugin will add content to the chunk but will not save it:

<?php
$eventName = $modx->event->name;
switch($eventName) {
    case 'OnChunkFormRender':
        //if we update the existing
        if ($mode == modSystemEvent::MODE_UPD) {
            //change the entire contents of the chunk
            $chunk->setContent('<p>New content</p>');
            $chunk->set('name','NewChunkName');
            $chunk->set('description','Description');
            //you can immediately save new content $chunk->save();
        }
        break;
}

See Also

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

  • modmore
  • Jens Wittmann – Gestaltung & Entwicklung
  • Digital Penguin
  • eydolan
  • deJaya
  • Following Sea
  • Nick Clark
  • Lefthandmedia
  • YJ
  • Sepia River Studios
  • Murray Wood
  • Dannevang Digital
  • Richard

Budget

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

Learn more