Jump to content

Snippets


teppo
 Share

Recommended Posts

A few days ago I stumbled upon this old module, which had been laying in the modules directory of one of my sites since 2017 in a half-finished state. I have no recollection why I left it like that, but figured it might be useful for someone, so here we go:

Snippets is a tool for injecting front-end code snippets (HTML/JS/CSS) into page content. The way it works is that you create a snippet — say, a Google Analytics tag — and then choose...

  • which element it should be tied to (there are some pre-populated choices and custom regex option),
  • whether it should be placed before/after said element or replace it entirely, and
  • which pages the snippet should apply to.

The "apply to" option also has some ready to use options (such as "all pages" and "all non-admin pages") or you can select specific pages... or use a selector. Snippets are regular markup, with the exception that you can use values from current page (behind the scenes the module makes use of wirePopulateStringTags()).

Available hooks:

  • Snippets::isApplicable, which receives the snippet object and current Page object as arguments and returns a boolean (true/false).
  • Snippets::applySnippet, which receives the snippet object, page content (string), variables (an object derived from WireData), and an array of options for wirePopulateStringTags() as arguments and returns the modified page content string.

snippets-list-view.thumb.jpg.616ab85a5c21a327b050063d659d2900.jpgsnippets-edit-view.thumb.jpg.1b05a0f88476a8a4abda5395fe751c7b.jpg

That's just about it. It's a pretty simple module, but perhaps someone will find this useful 🙂

  • Like 20
  • Thanks 1
Link to comment
Share on other sites

  • 4 weeks later...

Thank you very much for this another great contribution. We are allready using it in a first live-project.

I have one small bug:
When editing snippets it will not save for me with an exception when i uncheck "enabled". When i save it enabled and then disable it from the list view all is working fine, so there is a workaround. 
the exception i got:

SQLSTATE[23000]: Integrity constraint violation: 1048 Column 'enabled' cannot be null
In /site/modules/Snippets/ProcessSnippets.module.php line 319

Link to comment
Share on other sites

I just want to confirm that this module is awesome! And it does exactly what I needed.

I was able to move quite a few things from my templates into this module and even added this to a live-project today in order to be able to maintain JSON-LD/schema.org snippets much easier.

To be fair... you need most of the data in your pages and have to have quite a good structure to use the selector option in the module settings and such but... it works perfectly fine.

 

A quick outlook to those that want to play with this module:
If you need a special order for your snippets to load, you can tweak and change this with the snippet names.
AAA renders before DDD and don't use numbers as 110 comes before 90.
A name change later on won't help. ;)

So just in case you have different JS/CSS before </head> or something similar.

 

@teppo is there something on the way or planned in regards of PHP code within those snippets (if/else, ...) or to support variables from within _init.php and such?

  • Like 1
Link to comment
Share on other sites

1 hour ago, wbmnfktr said:

If you need a special order for your snippets to load, you can tweak and change this with the snippet names.
AAA renders before DDD and don't use numbers as 110 comes before 90.
A name change later on won't help. 😉

So just in case you have different JS/CSS before </head> or something similar.

Seems like it would be worthwhile to add priorities to snippets 🙂

1 hour ago, wbmnfktr said:

@teppo is there something on the way or planned in regards of PHP code within those snippets (if/else, ...) or to support variables from within _init.php and such?

I have considered allowing the use of Hanna Code tags in snippets. Would that make sense for your use case?

I'm not against other approaches, but this would be one way to keep Snippets relatively simple, while still allowing for more advanced use cases. Maybe 🙂

  • Like 1
  • Thanks 1
Link to comment
Share on other sites

5 minutes ago, teppo said:

Seems like it would be worthwhile to add priorities to snippets 🙂

I'd totally love that!

 

5 minutes ago, teppo said:

have considered allowing the use of Hanna Code tags in snippets. Would that make sense for your use case?

HANNA is almost everywhere I go... so in my case that would be a perfect match. And therefore I'd support that thought.

 

6 minutes ago, teppo said:

I'm not against other approaches, but this would be one way to keep Snippets relatively simple, while still allowing for more advanced use cases. Maybe 🙂

I'd be perfectly fine with those solutions as they are PW-native of some kind - at least in my setups. But sure... I'm open to other and even better options and solutions.

  • Like 1
Link to comment
Share on other sites

Hui... that was a show-stopper right here... while I was adding more scripts to the Snippets module on my personal site.

Got this error message:

Darn… Fatal Error: Uncaught Error: Call to a member function has() on string in site/modules/Snippets/Snippets.module.php:85

#0 wire/core/Wire.php (420): Snippets->___isApplicable()
#1 wire/core/WireHooks.php (951): Wire->_callMethod()
#2 wire/core/Wire.php (485): WireHooks->runHooks()
#3 site/modules/Snippets/Snippets.module.php(50): Wire->__call()
#4 wire/core/Wire.php (417): Snippets->hookPageRender()
#5 wire/core/WireHooks.php (1062): Wire->_callMethod()
#6 wire/core/Wire.php (485): WireHooks->runHooks()
#7 wire/modules/Process/ProcessPageView.module (225): Wire->__call()
#8 /wire/modules/Process/Proc (line 85 of site/modules/Snippets/Snippets.module.php)

This error message was shown because: you are logged in as a Superuser. Error has been logged.

While adding a simple JSON-LD to the homepage (ID 1) from within the selection tool.

2021-08-01_20-03.thumb.png.c3e6d2187161f1829bc1ecbdef34af4a.png

Fixed it for the moment by deleting the module, its database table and cleaning everything up with the Missing module dialogue within ProcessWire. 

Reinstalled the module afterwards and tried another single page... no luck. Still the same error.

 

  • Like 1
Link to comment
Share on other sites

  • 2 weeks later...

It's me again... this time with a weird finding.

There are 2 snippets with schema.org markup and some {{page.variables}} within them.

The first one (schema-restaurant) should be placed before </head> for pages with a specific template.

The second one (schema-sitepage) should be placed at the same spot (before </head>) on all non-admin pages.

Expectation:
schema-restaurant would be rendered on all restaurant pages based on the template selector.
schema-sitepage would be rendered on all pages across that website which are accessible in the frontend for users/guests.

Reality:
schema-restaurant gets rendered on all restaurant pages based on the template selector.
schema-sitepage gets rendered only on restaurant pages based on the template selector from schema-restaurant.

What I tried:
I deleted all snippets, added them again one after another, changed the position of the snippets, tried different snippet names and yet the seconds snippet won't render on all non-admin pages. I have to disable the first one (schema-restaurant) in order to see my schema-sitepage snippet.

 

UPDATE 2021/08/29:
Fixed in latest version.

Thanks, @teppo

2021-08-12_19-05.thumb.png.7d327800d5a41d2dfa74e7b871e693ab.png

  • Like 1
Link to comment
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
 Share

  • Recently Browsing   0 members

    • No registered users viewing this page.
  • Similar Content

    • By monollonom
      (once again I was surprised to see a work of mine pop up in the newsletter, this time without even listing the module on PW modules website 😅. Thx @teppo !)
      Github: https://github.com/romaincazier/FieldtypeQRCode
      Modules directory: https://processwire.com/modules/fieldtype-qrcode/
      This is a simple module I made so a client could quickly grab a QR Code of the page's url in the admin.
      There's not much to it for now, but if need be you can output anything using a hook:
      $wire->addHookAfter("FieldtypeQRCode::getQRText", function($event) { $page = $event->arguments("page"); $event->return = $page->title; // or could be: $event->return = "Your custom text"; }) You can also output the QR code on your front-end by calling the field:
      echo $page->qr_code_field; The module uses the PHP library QR Code Generator by Kazuhiko Arase. When looking for a way to generate a QR Code in PW I came across @ryan's integration in his TFA module. I'm not very familiar with fieldtype/inputfield module development so I blindly followed @bernhard (great) tutorial and his BaseFieldtypeRuntime. At some point I'll take a deeper look to make a module on my own.
      Some ideas for improvements :
      add the ability to choose what to ouput : page's url / editUrl / file(s) / image(s) / ... allow to output multiple QR codes ?
    • By Sebi
      AppApiFile adds the /file endpoint to the AppApi routes definition. Makes it possible to query files via the api. 
      This module relies on the base module AppApi, which must be installed before AppApiFile can do its work.
      Features
      You can access all files that are uploaded at any ProcessWire page. Call api/file/route/in/pagetree?file=test.jpg to access a page via its route in the page tree. Alternatively you can call api/file/4242?file=test.jpg (e.g.,) to access a page by its id. The module will make sure that the page is accessible by the active user.
      The GET-param "file" defines the basename of the file which you want to get.
      The following GET-params (optional) can be used to manipulate an image:
      width height maxwidth maxheight cropX cropY Use GET-Param format=base64 to receive the file in base64 format.
    • By MarkE
      This fieldtype and inputfield bundle was built for storing measurement values within a field, rendering them in a variety of formats and converting them to other units or otherwise modifying them via the API.
      The API consists of a number of predefined functions, some of which include...
      render() for rendering the measurement object, valueAs() for converting the value to another unit value, convertTo() for converting the whole measurement object to different units, and add() and subtract() for for modifying the stored value by the value (converted as required) in another measurement. In the admin the inputfield includes a checkbox (which can be optionally disabled) for converting values on page save. For an example if a value was typed in as centimeters, the unit was changed to metres, and the page saved with this checkbox selected, said value would be automatically converted so that e.g. 170 cm becomes 1.7 m.

      A simple length field using Fieldtype Measurement and Inputfield Measurement.
      Combination units (e.g. feet and inches) are also supported.
      Please note that this module is 'proof of concept' at the moment - there are limited units available and quite a lot of code tidying to do. More units will be added shortly.
      See the GitHub at https://github.com/MetaTunes/FieldtypeMeasurement for full details and updates.
    • By tcnet
      File Manager for ProcessWire is a module to manager files and folders from the CMS backend. It supports creating, deleting, renaming, packing, unpacking, uploading, downloading and editing of files and folders. The integrated code editor ACE supports highlighting of all common programming languages.
      https://github.com/techcnet/ProcessFileManager

      Warning
      This module is probably the most powerful module. You might destroy your processwire installation if you don't exactly know what you doing. Be careful and use it at your own risk!
      ACE code editor
      This module uses ACE code editor available from: https://github.com/ajaxorg/ace

      Dragscroll
      This module uses the JavaScript dragscroll available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability to drag the table horizontally with the mouse pointer.
      PHP File Manager
      This module uses a modified version of PHP File Manager available from: https://github.com/alexantr/filemanager
       
    • By tcnet
      This module implements the website live chat service from tawk.to. Actually the module doesn't have to do much. It just need to inserted a few lines of JavaScript just before the closing body tag </body> on each side. However, the module offers additional options to display the widget only on certain pages.
      Create an account
      Visit https://www.tawk.to and create an account. It's free! At some point you will reach a page where you can copy the required JavaScript-code.

      Open the module settings and paste the JavaScript-code into the field as shown below. Click "Submit" and that's all.

      Open the module settings
      The settings for this module are located int the menu Modules=>Configure=>LiveChatTawkTo.

       
×
×
  • Create New...