Jump to content
Nico Knoll


Recommended Posts

Hi Nico,

I am using your MarkupShortcodes for a new website I'm creating. It's a music theory and guitar lesson website - and I'm trying to implement a musical code language VexTab. 

[vextab width=800]

tabstave notation=yes


translates into

<div class="vex-tabdiv" width=800>

tabstave notation=yes


and there is more functionality, I will not bore you with this. 

My problem: when I use an hashtag (#) in this code, MarkupShortcodes won't recognize the [vextab]#[/vextab] as a shortcode. Same appears to be happening with &. I tried to translate the # into the html equivalent - but this doesn't help because this contains an hashtag as wel...

With my limited knowledge of PHP I tried to work it out myself but I haven't figured it out yet. Do you have an idea how to make your shortcode script compatible with some other symbols including #?

Thanks in advance!


Share this post

Link to post
Share on other sites

i understand this is a very old question...

Is it possible to get $page available inside the add function?

$shortcode->add('foo', function($atts){
    I WANT $page here!

if $page is available wherever you define the shortcode closure:

$shortcode->add('foo', function ($atts) use ($page) {
    //NOW I CAN USE $page here!

but of course, wire() makes all the pw api vars available to you.

  • Like 1

Share this post

Link to post
Share on other sites


Hello Niko,

i was thinking....

- we could define a standard or configurable location for the shortcode definition file.

- we could add an initialized property for the module

- when $shortcode->initialized == false we force the shortcode load the definition file and set $shortcode->initialized = true

. we check for initialized inside the render method, if not => load the file

so if we don't need shortcode rendering in a page render we avoid loading the definition file

use case (let's assume we wants to parse the body field)

if ($body = $page->body) {
    echo $shortcode->render($body);

if !$body => the definition file would not be loaded.

what do you think?

(in silverstripe 3.1 i ported the wp shortcode parser and the callbacks definition were actually static methods in a static class)

kind regards

Share this post

Link to post
Share on other sites

Hello Niko,

i quiclky ported the wp shortcodes parser i made for SIlverstripe 3.1 to this:


of course being a port of the same library it's quite similar to yours.

The module loads a default (*) definition file if found. You have also a public load($fullPath) to load other files other then default in templates. Or you can just use the add method. (*)I am in a hurry for a project so i didn't make it configurable, but that's easy to add.

Inside the definition files, since are included inside the class you add shortcodes like this:

$this->add('test1', function ($atts) {
    echo '<h3>This is a test shortcode with tag=test1</h3>';

in a template you can call:

$shortcodes->load($config->paths->templates .'/shortcodes/extra.inc');

to add custom definitions for that template

or simply, like your module:

$shortcodes->add('test2', function ($atts) {
    echo '<h3>This is a test shortcode with tag=test2</h3>';

let me know if you have other suggestions to make it better,

kind regards

Share this post

Link to post
Share on other sites


sorry for late answer but I were on vacation the last days.

Looks really nice what you have done. I had neither time for trying it nor compare it with my module but I definitely will do this within the next week.


-- Nico

Share this post

Link to post
Share on other sites

Thank You,

hope you enjoied your vacation. :-)

It was a real quick port I needed up and running. I'm sure that you - not being new at pw as am I - will be able to port the idea in a better and more elegant way into your more known and tested module.


  • Like 1

Share this post

Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By bernhard
      --- Please use RockFinder3 ---
    • By MoritzLost
      Cacheable Placeholders
      This module allows you to have pieces of dynamic content inside cached output. This aims to solve the common problem of having a mostly cacheable site, but with pieces of dynamic output here and there.  Consider this simple example, where you want to output a custom greeting to the current user:
      <h1>Good morning, <?= ucfirst($user->name) ?></h1> This snippet means you can't use the template cache (at least for logged-in users), because each user has a different name. Even if 99% of your output is static, you can only cache the pieces that you know won't include this personal greeting. A more common example would be CSRF tokens for HTML forms - those need to be unique by definition, so you can't cache the form wholesale.
      This module solves this problem by introducing cacheable placeholders - small placeholder tokens that get replaced during every request. The replacement is done inside a Page::render hook so it runs during every request, even if the response is served from the template cache. So you can use something like this:
      <h1>Good morning, {{{greeting}}}</h1> Replacement tokens are defined with a callback function that produces the appropriate output and added to the module through a simple hook:
      // site/ready.php wire()->addHookAfter('CachePlaceholders::getTokens', function (HookEvent $e) { $tokens = $e->return; $tokens['greeting'] = [ 'callback' => function (array $tokenData) { return ucfirst(wire('user')->name); } ]; $e->return = $tokens; }); Tokens can also include parameters that are parsed and passed to the callback function. There are more fully annotated examples and step-by-step instructions in the README on Github!
      A simple and fast token parser that calls the appropriate callback and runs automatically. Tokens may include multiple named or positional parameters, as well as multi-value parameters. A manual mode that allows you to replace tokens in custom pieces of cached content (useful if you're using the $cache API). Some built-in tokens for common use-cases: CSRF-Tokens, replacing values from superglobals and producing random hexadecimal strings. The token format is completely customizable, all delimiters can be changed to avoid collisions with existing tag parsers or template languages. Links
      Github Repository & documentation Module directory (pending approval) If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
    • By Craig
      I've been using Fathom Analytics for a while now and on a growing number of sites, so thought it was about time there was a PW module for it.
      WayFathomAnalytics is a group of modules which will allow you to view your Fathom Analytics dashboard in the PW admin panel and (optionally) automatically add and configure the tracking code on front-end pages.
      GitHub Readme & documentation Download Zip Modules directory Module settings screenshot What is Fathom Analytics?
      Fathom Analytics is a simple, privacy-focused website analytics tool for bloggers and businesses.

      Stop scrolling through pages of reports and collecting gobs of personal data about your visitors, both of which you probably don't need. Fathom is a simple and private website analytics platform that lets you focus on what's important: your business.
      Privacy focused Fast-loading dashboards, all data is on a single screen Easy to get what you need, no training required Unlimited email reports Private or public dashboard sharing Cookie notices not required (it doesn't use cookies or collect personal data) Displays: top content, top referrers, top goals and more
    • By daniels
      This is a lightweight alternative to other newsletter & newsletter-subscription modules.
      You can find the Module in the Modules directory and on Github
      It can subscribe, update, unsubscribe & delete a user in a list in Mailchimp with MailChimp API 3.0. It does not provide any forms or validation, so you can feel free to use your own. To protect your users, it does not save any user data in logs or sends them to an admin.
      This module fits your needs if you...
      ...use Mailchimp as your newsletter / email-automation tool ...want to let users subscribe to your newsletter on your website ...want to use your own form, validation and messages (with or without the wire forms) ...don't want any personal user data saved in any way in your ProcessWire environment (cf. EU data regulation terms) ...like to subscribe, update, unsubscribe or delete users to/from different lists ...like the Mailchimp UI for creating / sending / reviewing email campaigns *I have only tested it with PHP 7.x so far, so use on owners risk
      Since 0.0.4, instructions and changelog can be found in the README only. You can find it here  🙂
      If you have questions or like to contribute, just post a reply or create an issue or pr on github, thanks!
    • By MoritzLost
      Sorry for the convoluted title. I have a problem with Process modules that define a custom page using the page key through getModuleInfo (as demonstrated in this excellent tutorial by @bernhard). Those pages are created automatically when the module is installed. The problem is that the title of the page only gets set in the current language. That's not a problem if the current language (language of the superuser who is installing the module) is the default language; if it isn't, the Process page is missing a title in the default language. This has the very awkward effect that a user using the backend in the default language (or any other language) will see an empty entry in the setup menu:

      This screenshot comes from my Cache Control module which includes a Process page. Now I realize the description sounds obscure, but for us it's a common setup: We a multiple bilingual sites where the default language is German and the second language is English. While the clients use the CMS in German, as a developer I prefer the English interface, so whenever I install a Process module I get this problem.
      As a module author, is there a way to handle this situation? I guess it would be possible to use post-installation hooks or create the pages manually, but I very much prefer the declarative approach. The page title is already translatable (through the __ function), but of course at the time of installation there is no translation, and as far as I'm aware it's not possible to ship translations with a module so they are used automatically. Could this situation be handled better in the core? I would prefer if the module installation process would always set the title of the Process page in the default language, instead of the language of the current user.
  • Create New...