How To Use a MODx Plugin to Cache Snippets
I don’t want to take credit for this, but I definitely wanted to blog about it because I think it is a big deal. In a forum post I made on modxcms.com, ganeshXL came up with an awesome way to cache snippet output with a MODx plugin. Here is what ganeshXL wrote:
- create a chunk. Leave it empty. Name it whatever you want, e.g. testMenu
- create a plugin. Enter this:
$myChunk = 'testMenu'; // your chunk name
$params['startId'] = ‘0′;
$params['level'] = ‘4′;
$html = addslashes($modx->runSnippet(’Wayfinder’, $params));
$sql= “UPDATE ” . $modx->getFullTableName(”site_htmlsnippets”) . ” SET snippet=’$html’ WHERE name=’$myChunk’”;
$result= $modx->dbQuery($sql); - Check the system event OnDocFormSave + save the plugin.
- Change your template: Replace your Wayfinder call with your chunk: {{testMenu}}
Now, every time you edit a doc, the Menu code is being regenerated and stored in your chunk. This should speed up things quite a bit..
This is really cool since it means that you can cache snippet output and give php and mysql a break on processing your code. Like I said, all the credit goes to ganeshXL
If you’re interested in the context that this was created in, you can read the full post here.
782 views | 2 Comments »
Related Posts
- MODx SQL template, chunk, snippet, category install script
- DynamicDescription: Brand New Meta Description Snippet for MODx
- Auto Site Start MODx Resource Install Script
- Why MODx is my CMS of choice…
- Watch Out For Automatic Wordpress Updates
This post was created on January 28th 2008 09:34 pm



Comment by Dragan (ganeshXL)
on 18 Apr 2008 at 10:51 am #
Howdy! Surprised to find my little forum post here (I googled for something modx-related stuff); glad you found it useful.
Comment by James Ehly
on 21 Apr 2008 at 9:44 pm #
Thanks, I really did find your solution useful. I ended up modifying the final code to run from a module rather than a plugin, which worked out well for my client. The particular code just took too long to process after every doc save.