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 Robin S
      This module lets you add some custom menu items to the main admin menu, and you can set the dropdown links dynamically in a hook if needed.
      Sidenote: the module config uses some repeatable/sortable rows for the child link settings, similar to the ProFields Table interface. The data gets saved as JSON in a hidden textarea field. Might be interesting to other module developers?
      Custom Admin Menus
      Adds up to three custom menu items with optional dropdowns to the main admin menu.
      The menu items can link to admin pages, front-end pages, or pages on external websites.
      The links can be set to open in a new browser tab, and child links in the dropdown can be given an icon.
      Requires ProcessWire v3.0.178 or newer.
      Screenshots
      Example of menu items

      Module config for the menus

      Link list shown when parent menu item is not given a URL

      Advanced
      Setting child menu items dynamically
      If needed you can set the child menu items dynamically using a hook.
      Example:
      $wire->addHookAfter('CustomAdminMenus::getMenuChildren', function(HookEvent $event) { // The menu number is the first argument $menu_number = $event->arguments(0); if($menu_number === 1) { $colours = $event->wire()->pages->findRaw('template=colour', ['title', 'url', 'page_icon']); $children = []; foreach($colours as $colour) { // Each child item should be an array with the following keys $children[] = [ 'icon' => $colour['page_icon'], 'label' => $colour['title'], 'url' => $colour['url'], 'newtab' => false, ]; } $event->return = $children; } }); Create multiple levels of flyout menus
      It's also possible to create multiple levels of flyout submenus using a hook.

      For each level a submenu can be defined in a "children" item. Example:
      $wire->addHookAfter('CustomAdminMenus::getMenuChildren', function(HookEvent $event) { // The menu number is the first argument $menu_number = $event->arguments(0); if($menu_number === 1) { $children = [ [ 'icon' => 'adjust', 'label' => 'One', 'url' => '/one/', 'newtab' => false, ], [ 'icon' => 'anchor', 'label' => 'Two', 'url' => '/two/', 'newtab' => false, 'children' => [ [ 'icon' => 'child', 'label' => 'Red', 'url' => '/red/', 'newtab' => false, ], [ 'icon' => 'bullhorn', 'label' => 'Green', 'url' => '/green/', 'newtab' => false, 'children' => [ [ 'icon' => 'wifi', 'label' => 'Small', 'url' => '/small/', 'newtab' => true, ], [ 'icon' => 'codepen', 'label' => 'Medium', 'url' => '/medium/', 'newtab' => false, ], [ 'icon' => 'cogs', 'label' => 'Large', 'url' => '/large/', 'newtab' => false, ], ] ], [ 'icon' => 'futbol-o', 'label' => 'Blue', 'url' => '/blue/', 'newtab' => true, ], ] ], [ 'icon' => 'hand-o-left', 'label' => 'Three', 'url' => '/three/', 'newtab' => false, ], ]; $event->return = $children; } }); Showing/hiding menus according to user role
      You can determine which menu items can be seen by a role by checking the user's role in the hook.
      For example, if a user has or lacks a role you could include different child menu items in the hook return value. Or if you want to conditionally hide a custom menu altogether you can set the return value to false. Example:
      $wire->addHookAfter('CustomAdminMenus::getMenuChildren', function(HookEvent $event) { // The menu number is the first argument $menu_number = $event->arguments(0); $user = $event->wire()->user; // For custom menu number 1... if($menu_number === 1) { // ...if user does not have some particular role... if(!$user->hasRole('foo')) { // ...do not show the menu $event->return = false; } } });  
      https://github.com/Toutouwai/CustomAdminMenus
      https://processwire.com/modules/custom-admin-menus/
    • By tcnet
      This module for ProcessWire sends a notification email for each failed login attempt. Similar modules exists already in the module directory of ProcessWire. However, this module is designed to notify, even if specified user doesn't exist.
      Settings
      The settings for this module are located in the menu Modules=>Configure=>LoginFailNotifier.
      Notification email
      Specifies the email address to which the notification emails should be sent.
        Email subject
      Specifies the subject line for the notification email.
        Post variables
      Specifies the $_POST variables to be included in the notification email. Each variable must be separated by a comma. For example: login_name,login_pass
        Server variables
      Specifies the $_SERVER variables to be included in the notification email. Each variable must be separated by a comma. For example: REMOTE_ADDR,HTTP_USER_AGENT
      Link to ProcessWire module directory:
      https://processwire.com/modules/login-fail-notifier/
      Link to github.com:
      https://github.com/techcnet/LoginFailNotifier
    • By Fokke
      ProcessWire 3.x markup module for rendering meta tags in HTML document head section. Note that this module is not a full-blown SEO solution, but rather a simple tool for rendering meta tags based on module configuration. Adding custom meta tags is also supported.
      Built-in meta tags
      The following meta tags are supported out-of-the-box:
      Document title consisting of page title and site name Character set Canonical Viewport Description Keywords Hreflang tags Open Graph og:title og:site_name og:type og:url og:description og:image og:image:width og:image:height Twitter meta tags twitter:card twitter:site twitter:creator twitter:title twitter:description twitter:image Facebook meta tags fb:app_id The full documentation with configurable options can be found here: https://github.com/Fokke-/MarkupMetadata
       
      Requirements:
      ProcessWire>=3.0.0 PHP >=7.1 Installation using Composer
      composer require fokke/markup-metadata Manual installation
      Download latest version from https://github.com/Fokke-/MarkupMetadata/archive/master.zip Extract module files to site/modules/MarkupMetadata directory.
    • By m.sieber
      ITRK-Service for ProcessWire
      Module for the automated transfer of imprint, data protection declaration and terms and conditions from IT-Recht Kanzlei to your ProcessWire installation
      What is ITRK Service for ProcessWire?
      ITRK-Service for ProcessWire is a free module for ProcessWire CMS. It provides an interface to the update service of IT-Recht Kanzlei, via which the legal texts of your online presence are automatically updated. In this way, the texts remain legally secure and warning-proof in the long term. Imprint, data protection declaration, revocation and general terms and conditions are currently supported.
      You can find our documentation (in german language) here: https://www.pupit.de/itrk-service-for-processwire/dokumentation/

      Download: https://www.pupit.de/itrk-service-for-processwire/
      Github: https://github.com/pupit-de/pwItrkServiceConnector
    • By LuisM
      Symprowire is a PHP MVC Framework based and built on Symfony using ProcessWire 3.x as DBAL and Service-Provider
      It acts as a Drop-In Replacement Module to handle the Request/Response outside the ProcessWire Admin. Even tough Symfony or any other mature MVC Framework could be intimidating at first, Symprowire tries to abstract Configuration and Symfony Internals away as much as possible to give you a quick start and lift the heavy work for you.
      The main Goal is to give an easy path to follow an MVC Approach during development with ProcessWire and open up the available eco-system.
      You can find the GitHub Repo and more Information here: https://github.com/Luis85/symprowire
      Documentation
      The Symprowire Wiki https://github.com/Luis85/symprowire/wiki How to create a simple Blog with Symprowire https://github.com/Luis85/symprowire/wiki/Symprowire-Blog-Tutorial Last Update
      16.07.2021 // RC 1 v0.6.0 centralized ProcessWire access trough out the Application by wrapping to a Service https://github.com/Luis85/symprowire/releases/tag/v0.6.0-rc-1 Requirements
      PHP ^7.4 Fresh ProcessWire ^3.0.181 with a Blank Profile Composer 2 (v1 should work, not recommended) The usual Symfony Requirements Features
      Twig Dependency Injection Monolog for Symprowire Support for .env YAML Configuration Symfony Console and Console Commands Symfony Webprofiler Full ProcessWire access inside your Controller and Services Webpack Encore support Caveats
      Symfony is no small Framework and will come with a price in terms of Memory Usage and added Overhead. To give you a taste I installed Tracy Debugger alongside to compare ProcessWire profiling with the included Symfony Webprofiler

      So in a fresh install Symprowire would atleast add another 2MB of Memory usage and around 40ms in response time, should be less in production due to the added overhead of the Webprofiler in dev env
       
×
×
  • Create New...