How to know if a snippet is firing or not?

1,154 Posts

nuan88 Reply #1, 10 years, 7 months ago

There is an interesting problem here (https://forums.modx.com/thread/99411/update-profile-link-doesn-t-work), where the update profile snippet isn't working. The behavior is a blank page which does resolve.

How to know if the snippet is firing? How to debug this issue? Its using the standard snippet, which usually works.

This question has been answered by treigh. See the first response.

discuss.answer

833 Posts

treigh Reply #2, 10 years, 7 months ago

Here's a start: How to Write a Good Snippet

Error logging is particularly very useful:

Here's an example from the link, that checks if inputs are provided:

// Verify Inputs
if (!isset($scriptProperties['x']) || !isset($scriptProperties['y'])) {
    $modx->log(modX::LOG_LEVEL_ERROR, '[mySnippet] missing required properties &x and &y!');
    return;
}

A MODx Fanatic

24,544 Posts

BobRay Reply #3, 10 years, 7 months ago

If it's not clear if the code is running or not, I like to start with this one-liner at the top of the snippet or plugin code:

$modx->log(modX::LOG_LEVEL_ERROR, '[snippet name] is executing');

If nothing gets written to the error log, it's not executing.

You can also duplicate or move the message around to see if the various parts of the code are executing.

Did I help you? Buy me a beer
Get my Book: MODX:The Official Guide
MODX info for everyone: http://bobsguides.com/modx.html
My MODX Extras
Bob's Guides is now hosted at A2 MODX Hosting

1,154 Posts

nuan88 Reply #4, 10 years, 7 months ago

At the top, before the [[! ? Or within the snippet?

☆ A M B ☆
24,524 Posts

sottwell Reply #5, 10 years, 7 months ago

At the beginning of the snippet code. https://rtfm.modx.com/revolution/2.x/developing-in-modx/basic-development/snippets/how-to-write-a-good-snippet

Studying MODX in the desert - http://sottwell.com
Tips and Tricks from the MODX Forums and Slack Channels - http://modxcookbook.com
Join the Slack Community - http://modx.org

1,154 Posts

nuan88 Reply #6, 10 years, 7 months ago

Ah thank you all

Answered How to know if a snippet is firing or not?