Jump to content

Prism Syntax Highlighter

Recommended Posts

ProcessWire Prism JS Syntax Highlighter

A module to parse given HTML and syntax-highlight code elements using Prism JS


  • Support for 120 languages
  • Very lightweight, core weights 2KB minified gzipped. 
  • Customizable. Specify your own CSS, or use one of 8 default themes 
  • Hookable. Use hooks to specify your own custom CSS, and JS 
  • Plugin support. You can use all available plugins that come with Prism JS. 


  • Add module to /site/modules/ and then install.
    Or go to Modules > Install > Add New and use any of the options provided to to install.
  • Create a text/textarea field or use an existing one then pick Prism Code Highlighter from Details > Text Formatters
    Protip: This module parses HTML markup, so it should come after HTML parsers such as Markdown textformatters. 
  • Add code elements within the field content with language-xxxx classes.
    Or pick a default language from configuration page if you are unable to specify the classes. 
  • Go to configuration page and select any plugins you want. To use some plugins, extra classes are required. See plugin documentation
  • Install these recommended modules for the best experience: 
    Parsedown Extra module to render Markdown Extra into HTML. You can also set custom attributes for each element unlike vanilla Markdown. 


  • Go to module configuration to specify:  Auto inclusion of highlighters for parsed languages 
  • Default language for inline code elements or ones without language-xxxx classes. 
  • Ability to use minified/non-minified component and parser files 
  • Plugin options
  • Theme options
  • Custom JS and CSS for configuration / theming 
  • Ability to use hooks to specify custom CSS and JS 


  • Hook into TextformatterPrism::getCustomCss and TextformatterPrism::getCustomJs in your ready.php file and return an (array of) URLs as follows: 
// specify custom CSS
wire()->addHookAfter('TextformatterPrism::getCustomCss', function (HookEvent $event) {
    $event->return = 'path/to/custom.css';
// Specify custom JS
wire()->addHookAfter('TextformatterPrism::getCustomJs', function (HookEvent $event) {
    $event->return = ['path/to/custom.js', 'another/custom.js'];



2017-01-12 19_53_15-Modules • ProcessWire • abdus.dev.png

2017-01-12 19_53_00-Practical Uses of Hooks in Processwire - abdus.png



  • Like 17

Share this post

Link to post
Share on other sites

Good Day,

I have installed this module to test out on a new site that I'm building.  It shows as Version 0.0.1

When I go to Upgrade it shows that there is a Version 1.0.0



Once You go to upgrade, it says that things were upgraded however it's still at Version 0.0.1



Any help that you can provide is greatly appreciated.


Share this post

Link to post
Share on other sites

I forgot to update module info file. Fixed it and pushed v1.0.1, module repository should update in a day I guess.

Thanks a lot for the heads up!

  • Like 2

Share this post

Link to post
Share on other sites
3 minutes ago, abdus said:

module repository should update in a day I guess.

No need to wait for a day. Go to your module in the repo, click button to edit it and immediately save; (no need to edit anything actually). Voila, it is updated in the repo! :).

  • Like 2

Share this post

Link to post
Share on other sites
1 minute ago, kongondo said:

No need to wait for a day. Go to your module in the repo, click button to edit it and immediately save; (no need to edit anything actually). Voila, it is updated! :).

Done! Thanks.

  • Like 2

Share this post

Link to post
Share on other sites

Somehow your module does not work correctly in my ProcessWire. I am using 3.0.71 right now.

I have this code in my body field and your textformatter applied to the body field:

<code class="language-php">
echo "this is PHP";

After outputting it on my site it shows up as:

<code class=" language-php language-php">
<span class="token keyword">echo</span> <span class="token string">"this is PHP"</span><span class="token punctuation">;</span>
    <script src="/site/modules/TextformatterPrism/prism/prism.js"></script>
    <script src="/site/modules/TextformatterPrism/prism/components/prism-php.js"></script>                       

So as you can see, it the first pre tag is destroyed/converted and the closing pre tag is removed. 


Share this post

Link to post
Share on other sites

Just in case someone else stumbles over this, you'll need to modify these lines at the end of method format() in TextformatterPrism.module:

        $markup = $dom->saveHTML($dom->getElementsByTagName('body')->item(0));
        $markup = ltrim(rtrim($markup, '</body>'), '<body>');

Into this:

        $markup = $dom->saveHTML($dom->getElementsByTagName('body')->item(0)->nodevalue);

Reason is, that ltrim/rtrim do not trim strings but character groups. So they do not stop after the <body> tag but continue to strip any following char if its one of "<>bdoy"...

Using nodevalue (or textcontent) from the body element eliminates the need for the trim.

  • Like 1

Share this post

Link to post
Share on other sites

Just realized that saveHTML automatically adds doctype and <html><body> frame around the content (from PHP 5.2.6).

Edit: For PHP >= 5.4.0 better change loading the HTML from

$dom->loadHTML(mb_convert_encoding($str, 'HTML-ENTITIES', 'UTF-8'));


$dom->loadHTML(mb_convert_encoding($str, 'HTML-ENTITIES', 'UTF-8'), LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);





so that should be removed using something like (5.2.6 <= PHP < 5.4.0) :

		// Remove added doctype/html/body added from saveHTML
		$markup = preg_replace('/^<!DOCTYPE.+?>/', '',
			str_replace( array('<html>', '</html>', '<body>', '</body>'),
						 array('', '', '', ''),


Share this post

Link to post
Share on other sites

Ok, DOMDocument drives me crazy. It does not properly work without a surrounding container, so I've changed the loadHTML as follows:

$dom->loadHTML('<div>'.mb_convert_encoding($str, 'HTML-ENTITIES', 'UTF-8').'</div>', LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);

This, of course, needs to be cleaned up at the end, which I quick&dirty done like this:

						// strlen('<div>') = 5
$markup = substr(trim($dom->saveHTML($dom)), 5, -6);

The trim is required, since the return of saveHTML ends with a newline and I don't want to hard-encode this using -7 for the length parameter of substr, sigh.

Edit: changed <dummycontainer> to <div> to make loadHTML happy.

Share this post

Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By Robin S
      A community member raised a question and I thought a new sanitizer method for the purpose would be useful, hence...
      Sanitizer Transliterate
      Adds a transliterate method to $sanitizer that performs character replacements as defined in the module config. The default character replacements are based on the defaults from InputfieldPageName, but with uppercase characters included too.
      Install the Sanitizer Transliterate module.
      Customise the character replacements in the module config as needed.
      Use the sanitizer on strings like so:
      $transliterated_string = $sanitizer->transliterate($string);
    • By dimitrios
      this module can publish content of a Processwire page on a Facebook page, triggered by saving the Processwire page.
      To set it up, configure the module with a Facebook app ID, secret and a Page ID. Following is additional configuration on Facebook for developers:
      Minimum Required Facebook App configuration:
      on Settings -> Basics, provide the App Domains, provide the Site URL, on Settings -> Advanced, set the API version to 2.10, add Product: Facebook Login, on Facebook Login -> Settings, set Client OAuth Login: Yes, set Web OAuth Login: Yes, set Enforce HTTPS: Yes, add "http://www.example.com/processwire/page/" to field Valid OAuth Redirect URIs. This module is configurable as follows:
      Templates: posts can take place only for pages with the defined templates. On/Off switch: specify a checkbox field that will not allow the post if checked. Specify a message and/or an image for the post.
      edit the desired PW page and save; it will post right after the initial Facebook log in and permission granting. After that, an access token is kept.
      PW module directory: http://modules.processwire.com/modules/auto-fb-post/ Github: https://github.com/kastrind/AutoFbPost   Note: Facebook SDK for PHP is utilized.

    • By thomasaull
      I created a little helper module to trigger a CI pipeline when your website has been changed. It's quite simple and works like this: As soon as you save a page the module sets a Boolean via a pages save after hook. Once a day via LazyCron the module checks if the Boolean is set and sends a POST Request to a configurable Webhook URL.
      Some ideas to extend this:
      make request type configurable (GET, POST) make the module trigger at a specified time (probably only possible with a server cronjob) trigger manually Anything else? If there's interest, I might put in some more functionality. Let me know what you're interested in. Until then, maybe it is useful for a couple of people 🙂
      Github Repo: https://github.com/thomasaull/CiTrigger
    • By Robin S
      I created this module a while ago and never got around to publicising it, but it has been outed in the latest PW Weekly so here goes the support thread...
      Unique Image Variations
      Ensures that all ImageSizer options and focus settings affect image variation filenames.

      When using methods that produce image variations such as Pageimage::size(), ProcessWire includes some of the ImageSizer settings (height, width, cropping location, etc) in the variation filename. This is useful so that if you change these settings in your size() call a new variation is generated and you see this variation on the front-end.
      However, ProcessWire does not include several of the other ImageSizer settings in the variation filename:
      upscaling cropping, when set to false or a blank string interlace sharpening quality hidpi quality focus (whether any saved focus area for an image should affect cropping) focus data (the top/left/zoom data for the focus area) This means that if you change any of these settings, either in $config->imageSizerOptions or in an $options array passed to a method like size(), and you already have variations at the requested size/crop, then ProcessWire will not create new variations and will continue to serve the old variations. In other words you won't see the effect of your changed ImageSizer options on the front-end until you delete the old variations.
      The Unique Image Variations module ensures that any changes to ImageSizer options and any changes to the focus area made in Page Edit are reflected in the variation filename, so new variations will always be generated and displayed on the front-end.
      Install the Unique Image Variations module.
      In the module config, set the ImageSizer options that you want to include in image variation filenames.
      Installing the module (and keeping one or more of the options selected in the module config) will cause all existing image variations to be regenerated the next time they are requested. If you have an existing website with a large number of images you may not want the performance impact of that. The module is perhaps best suited to new sites where image variations have not yet been generated.
      Similarly, if you change the module config settings on an existing site then all image variations will be regenerated the next time they are requested.
      If you think you might want to change an ImageSizer option in the future (I'm thinking here primarily of options such as interlace that are typically set in $config->imageSizerOptions) and would not want that change to cause existing image variations to be regenerated then best to not include that option in the module config after you first install the module.
    • By Sebi
      I've created a small module which lets you define a timestamp after which a page should be accessible. In addition you can define a timestamp when the release should end and the page should not be accessable any more.
      ProcessWire-Module: http://modules.processwire.com/modules/page-access-releasetime/
      Github: https://github.com/Sebiworld/PageAccessReleasetime
      PageAccessReleasetime can be installed like every other module in ProcessWire. Check the following guide for detailed information: How-To Install or Uninstall Modules
      After that, you will find checkboxes for activating the releasetime-fields at the settings-tab of each page. You don't need to add the fields to your templates manually.
      Check e.g. the checkbox "Activate Releasetime from?" and fill in a date in the future. The page will not be accessable for your users until the given date is reached.
      If you have $config->pagefileSecure = true, the module will protect files of unreleased pages as well.
      How it works
      This module hooks into Page::viewable to prevent users to access unreleased pages:
      public function hookPageViewable($event) { $page = $event->object; $viewable = $event->return; if($viewable){ // If the page would be viewable, additionally check Releasetime and User-Permission $viewable = $this->canUserSee($page); } $event->return = $viewable; } To prevent access to the files of unreleased pages, we hook into Page::isPublic and ProcessPageView::sendFile.
      public function hookPageIsPublic($e) { $page = $e->object; if($e->return && $this->isReleaseTimeSet($page)) { $e->return = false; } } The site/assets/files/ directory of pages, which isPublic() returns false, will get a '-' as prefix. This indicates ProcessWire (with activated $config->pagefileSecure) to check the file's permissions via PHP before delivering it to the client.
      The check wether a not-public file should be accessable happens in ProcessPageView::sendFile. We throw an 404 Exception if the current user must not see the file.
      public function hookProcessPageViewSendFile($e) { $page = $e->arguments[0]; if(!$this->canUserSee($page)) { throw new Wire404Exception('File not found'); } } Additionally we hook into ProcessPageEdit::buildForm to add the PageAccessReleasetime fields to each page and move them to the settings tab.
      In the current version, releasetime-protected pages will appear in wire('pages')->find() queries. If you want to display a list of pages, where pages could be releasetime-protected, you should double-check with $page->viewable() wether the page can be accessed. $page->viewable() returns false, if the page is not released yet.
      If you have an idea how unreleased pages can be filtered out of ProcessWire selector queries, feel free to write an issue, comment or make a pull request!
  • Create New...