An excellent set of snippet guidelines can be found in the MODx Wiki, here.

The current document's ID is available in a snippet by using

$id = $modx->documentIdentifier;

Note:Do not use:

$id = $modx->getDocumentIdentifier('id');

because it will interfere with using Friendly URLs.

Snippet names are case-sensitive. Be sure there is an exact match between the name of the snippet and the name used in the snippet tag. That's the most common cause of no output. You may also have an error in your php code (e.g. a missing semicolon at the end of a line) or an error in the html code generated by your snippet.

The Rich Text Editor has altered the text of the document holding the snippet tag. Depending on the settings, the Rich Text Editor (RTE) will replace some characters with their HTML entities, including the brackets and ampersands in a snippet tag. When that happens, MODx won't recognize it as a snippet tag and will just pass it on to the browser for display.

To fix this, edit the document that holds the snippet tag. Uncheck the Rich Text checkbox and click on Save. Now you'll be looking at the raw HTML code of the document. Make sure the snippet tag shows nothing but the call itself (or paste it in fresh). In the future, either leave the RTE off, or reconfigure the RTE to stop it from translating HTML entities.

Snippet properties are case-sensitive and should always be enclosed in backticks (`), never single or double quotes. The back tick is usually on the key with the tilde character (~). Failing to use backticks around snippet properties is, by far, the most common error for beginning snippet developers.

Yes, but it's better to use a variable or a placeholder. For a very simple snippet, use a variable (by convention, almost all snippet developers use the variable $output). Put your output in that variable and return it. Example:

$output="";
$name = "Bob";
$output = "Hello ";  // set $output to "Hello "
$output .= $name;   // tack name onto the end of $output
$output .=", glad you could make it."; //add a greeting
return $output;

For more complex snippets, you should use placeholders for the dynamic content and return a chunk containing those placeholders. Example:

Create a chunk called Greeting that contains the following:

Hello [+firstName+], glad you could make it.

Now, in your snippet, just do this:

$name = "Bob";
$modx->setPlaceholder('firstName', $name);
return $modx->getChunk('Greeting');

This separates the logic of your snippet from the presentation.

In a snippet, the API function $modx->userLoggedIn() returns true if the user is logged in.

The function $modx->getLoginUserName( ) will get the user's name. The function $modx->getLoginUserID() will return the user's ID. Be sure to use $modx->userLoggedIn() first to make sure that there is a logged in user to check on.

/* See if the page visitor is a logged in web user or manager user */

if (userLoggedIn()) {
   $userID =  $modx->getLoginUserID();
   $userName = $modx->getLoginUserName();
} else {
   // Page visitor is not logged in anywhere.
}

Snippet properties are available in the snippet code as regular PHP variables. The property &`fileName` can be accessed in the snippet as $fileName like any other PHP variable.

You can also access the properties via the associative array $modx->event->params in MODx Evolution. In MODx Revolution, they are available in the $scriptProperties array.

MODx Evolution:

$myVariable = $modx->event->params['fileName'];

MODx Revolution:

$myVariable = $scriptProperties['fileName'];

This second method can be useful inside a function. Note that the two methods access separate variables so changes to one won't affect the other. In other words, $filename = 'newFileName'; won't affect the params or $scriptProperties array member.

Yes. In fact it's the preferred method for all but the simplest snippets. The best method is to declare a class member variable for every snippet property you need. Then, set those class member variables equal to the properties in the class constructor (see code in the question below). They will then be available throughout the class's methods/functions as

$this->memberVariable. 

If you need the $modx object inside class functions, pass it to the class constructor as an argument and set a class member variable to it (e.g. $this->myModx =& $modx<) in the constructor. It will then be available everywhere in the class as

$this->myModx.

Use two constructor functions like the following:

class MyClass {
    var $myModx;
    var $property1;
    var $property2;

/* PHP5 Constructor */
    function __construct($myModx, $property1, $property2) {
        $this->myModx =& $myModx;
        $this->property1 = $property1;
        $this->property2 = $property2;
    }
}

Use the getChunk() function:

$chunkContents = $modx->getChunk('chunk_name');

Information about the current document (the one the snippet is embedded in) is available via the $modx document object using code like the following:

$modx->documentObject['objectName'];

The most commonly used object names are: content, pagetitle, longtitle, alias, description, and menutitle. For a more complete list, look here.

System setting values are available using this format:

$yourVariable = $modx->config['setting_name'];

For a fairly complete list of what's available this way, look here under the "Settings" heading.

This is the PHP ternary operator. The form is:

(expression 1) ? (expression 2) : (expression 3);

If (expression1) is true, the code evalates to (expression2), if (expression 1) is false, the code evaluates to (expression 3).

Since the use may or may not have set a particular snippet property, it's good practice to check and handle things either way.

The isset() function checks to see if the property is set and, most of the time, the line can be read this way:

Is the property set? If yes, use it: if no, use the default value;

Example:

$val = isset($property)? $property : $default;

Another version of this uses the empty() function to see if the property is set:

$val = empty($property)? $default : $property;

Note that the method described above can give unexpected results in MODx Revolution for existing default properties and properties in property sets because, in those cases, isset() will always return true.

That usually means the $modx object is not available at that point in your code. If the code is inside a function, you have to put:

global $modx;

at the top of the function in order to let PHP know that you mean it to use the $modx object from outside the function rather than creating a new one. If that doesn't work, sometimes you need to pass $modx as an argument to the function containing the code.

The API function isBackend() returns true only if the current page is accessed via the manager.

prefix the path with $modx->config['base_path'] and append the path to the file.

include $modx->config['base_path'] . 'assets/snippets/mysnippet/myfile.php';

That way, the code will work even if it is moved to another server.

Prefix the URL with $modx->config['base_url'] and append the path to the resource.

$url = $modx->config['base_url'] . 'assets/images/myimage.jpg';

That way, the code will still work if you move it to another server.

Use $modx->sendRedirect($url). It's best to have MODx generate the URL using

$modx->makeUrl($id)

where $id is the resource ID of the document you want to send them to. To send users to the document with the ID of 12, for example:

$url = $modx->makeUrl(12);
$modx->sendRedirect($url);

To forward to the current page, have the snippet do this:

$output = '<form action="[~[*id*]~]" >';
//etc.

To forward to a page with the id of 12, have the snippet do this:

$output = '<form action="[~12~]" >';
//etc.

Use a $_SESSION variable. In snippet 1:

$num = 23;
$str = 'I'm saving this for use later';

$_SESSION['myNum'] = $num;
$_SESSION ['myString'] = $str;

In snippet 2:

$num = $_SESSION['myNum'];
$str = $_SESSION ['myString'];

Usually that's a cache issue. If your menu snippet (usually Wayfinder) is called cached, the menus won't show anything new until the cache is cleared (and it's usually cleared when you edit and save a document). See: 'How can I clear the MODx cache from inside a snippet.

Add this function to your snippet and call it to clear the cache:

function clearCache() {	
    include_once "manager/processors/cache_sync.class.processor.php";
    $sync = new synccache();
    $sync->setCachepath("assets/cache/");
    $sync->setReport(true);
    $sync->emptyCache();
}

In order to keep MODx from executing the code, an HTML comment is sometimes inserted in the code. If you cut and paste, you may have to remove those comments:

<!-- -->

This usually means that you have the Rich Text editor turned on for that document. The editor is trying to be helpful by encoding html entities in the snippet tag. On the Document Create/Edit screen for the document containing your snippet tag, go to the Page Settings tab an uncheck the "rich text" box. Save the document. Then look at it in the editor. Change the snippet tag back to its original form (e.g. restore the [ and ] characters and change & followed by "&" back to just an ampersand. To avoid this in the future if you want to use the Rich Text editor, go to Resources | Manage Resources | Plugins | TinyMCE | Configuration tab. Change "entity encoding" to "raw." Some people also like to disable "cleanup."

Most often, it means you have an extra "<?php" in your snippet code. Sometimes it means you have ">" rather than "->" in a line of code.

There are several causes. Here are the most common:

• Missing end-of-line semicolon
• Malformed comment or a comment without comment tags
• Missing parentheses around if() statement condition
• Missing one of a pair of parentheses, quotes, braces, or brackets
• Improperly nested parentheses, quotes, braces, or brackets:

  if (condition { (

• Space between the "<?" and "php" at the beginning of the snippet