Jump to content

Module: RuntimeMarkup Fieldtype & Inputfield


Recommended Posts

@kongondo - thanks - yes, i could also just delete and remake the field, since i can copy the code, and there is no risk of losing entered data...

it would be good to fix though, as surely someone along the way is going to try and rename one of these..

Link to comment
Share on other sites

 In relation to lister -

So i have this module generating a dynamic link (the link is based off the combination of a page select and some attributes of the page being edited); to get it to work in lister, e.g. where it doesn't end up getting entity encoded, i added this to ready.php:

wire()->addHookAfter('FieldtypeRuntimeMarkup::markupValue', function($event) {
  $value = $event->arguments('value');
  $event->return = $value;

should the module assume that the output will be markup and therefore also provide a markupValue by default, or leave this up to the user to add as a hook?

  • Like 1
Link to comment
Share on other sites

 In relation to lister -

....should the module assume that the output will be markup and therefore also provide a markupValue by default, or leave this up to the user to add as a hook?

Thanks. Good idea. Will provide the method.

Link to comment
Share on other sites

@kongondo - thanks - yes, i could also just delete and remake the field, since i can copy the code, and there is no risk of losing entered data...

it would be good to fix though, as surely someone along the way is going to try and rename one of these..


Reported the issue and Ryan fixed it in this commit. I've tested it and it works.

Link to comment
Share on other sites

  • 2 months later...

How can I have the button open a url in a modal? I can't quite get it to work. The modal does appear but then the browser goes to the url.

$url = 'http://example.com';
$out = '<a href="'.$url.'" class="pw-modal pw-modal-large" data-buttons="#non_rte_dialog_buttons button" data-autoclose="1" data-close="#non_rte_cancel">';
$out .= '<button type="button" name="button" class="ui-button ui-widget ui-corner-all ui-state-default">';
$out .= '<span class="ui-button-text">Image Archive</span></button>';
$out .= '</a>';
return "<div class='pfabLink'>".$out."</div>";


Link to comment
Share on other sites

The page has image field's thumbnail images which use modal and have those "pw-modal" classes and work just fine, so any necessary js and css are in place already. I'd seen that Adrian comment so I know it can be done.

I'm new to jqueryUI so I don't understand the handling of the click event and at what point it does something (return false?) to stop the browser from processing the link as a link and going off to another page. There must be some condition which isn't being met. Could it be a matter of what the A tag is wrapped in?

Answer: Don't use an A tag! Seems simple enough. Just do it all with the button, putting the url in a "data-href" attribute on the button. It's working now.

Drifting off topic but any tips on how best to generate the boilerplate page markup for this iframe so that admin theme styling for an AdminDataTable works. I'm about halfway there.

  • Like 1
Link to comment
Share on other sites

Hey guys - I actually removed that popup link I was using - not because it didn't work great with RuntimeMarkup, but for other reasons - anyway, I don't have the code I used for it anymore.

But, this works for me:

$url = 'http://www.example.com';
$out = '<button data-href="'.$url.'" type="button" name="button" class="pw-modal pw-modal-large ui-button ui-widget ui-corner-all ui-state-default">';
$out .= '<span class="ui-button-text">Image Archive</span></button>';
return "<div class='pfabLink'>".$out."</div>";
  • Like 1
Link to comment
Share on other sites

Yup, working for me too. The only wierdness left has to do with button color. Using the default admin theme it's green and turns sort of purple after being clicked to launch the modal. It stays that color after the modal is closed and that seems wrong.

Link to comment
Share on other sites

Yeah, it needs to be refreshed (the button, i.e.)...

You can use JS for that. Which reminds me, This module comes with an empty InputfieldRuntimeMarkup.js...in which I foolishly state: 

/*Use this file for scripts (js) for your renderend Markup in the page edit in admin, i.e. in the rendered InputfieldRuntimeMarkup*/

...as if those wouldn't be overwritten on the next upgrade, grrr!

Anyway, I will either let the module check for and if found include an 'InputfieldRuntimeMarkupCustom.js', which won't get overwritten on upgrades, or simply, I will ship the module  without a  'InputfieldRuntimeMarkup.js' (and without a  'InputfieldRuntimeMarkup.css' as well). In that case, PW will autoload those files if found and they'll never get overwritten.

So, to your solution. Add the following to your 'InputfieldRuntimeMarkup.js': @note: I added an id="archives" to your button

  $('button#archives').on('click', function(){
  //refresh button (remove 'ui-state-active') (only needed for default theme)

The code could probably be optimized to only run if default admin theme is in use. Maybe could even be used inline but this is cleaner. Maybe there's better solutions as well. The blue (on Chrome) outline around the button can be removed using CSS.

Edited by kongondo
  • Like 1
Link to comment
Share on other sites

ok, adding buttons is easy and helpful. can someone help me out when i want to add input fields as well?

usecase is a simple form with one inputfield and one button to copy a page and save it with the name specified in the textfield.

i was able to display the field + button but i was not able to get the data of the field. my $input->post was empty all the time. i tried it like this:

return wireRenderFile('markup/_createcustomcopy');
$field = $modules->get("InputfieldText");
$field->label = "Name";
$field->required = 1;
echo $field->render(); // append the field to the form

// oh a submit button!
$submit = $modules->get("InputfieldSubmit");
$submit->attr("value","create copy");
echo $submit->render();

echo print_r($input->post, true);


i hope someone can point me in the right direction :)

Link to comment
Share on other sites

I don't share the warm fuzzy feelings I get when I use people's modules nearly often enough, so I just left a comment on the module directory page.

The short version is that it's saving me from having to create custom modules for a lot of places where I'd want to output some custom, processed output when editing a page and it is streamlining some of the steps I need to perform when approving entries in the dev directory, so thanks for this!

  • Like 7
Link to comment
Share on other sites


You should be getting a couple of errors with that code (if you have debug on). In that context, PW doesn't know what $modules and $input are (see similar issues on page 1 of this thread). You need to use $this-> or wire('modules'). Secondly, the module will only return a string or integer. You need to save string/integer output in a variable (e.g. $out) and return $out;

Link to comment
Share on other sites

hi kongondo,

sorry, it seems i was not clear enough.

in the markup field settings i have

return wireRenderFile(...);

and in this file i have code like this

// some code here
$out .= 'xxx';
$out .= 'yyy';

echo $out;

so i think at least this should not be a problem as i am only returning a string of html. i was also confused why $modules was available in the file from wireRenderFile() but i guess it has something to do with that method. but to be honest i did not investigate that further.

Link to comment
Share on other sites

Aah, I see. That's a cool usage of the module you got there! ^-^. Using wireRenderFile() keeps the module's input clean, circumvents limit of text allowed in that field plus makes the module much more versatile. One can do all sorts of flexible includes from within the file rendered by wireRenderFile(), depending on the context. :)

I have tested and it works fine here creating a new page (see below). Cloning a page on the other hand leads to a cyclical error (or memory issue) and crashes Apache. 

In details tab of this module I have:

return wireRenderFile('test');

In /site/templates/test.php

$out ='';

$f = $modules->get("InputfieldText");
$f->label = "Copy Title";// @note: doesn't seem to work
$f->required = 1;// @note: -ditto-
$out= $f->render(); // append the field to the form

// oh a submit button!
$f = $modules->get("InputfieldSubmit");
$f->attr("value","Create Copy");
$out .= $f->render();

$currentPage = '';
$process = wire('process'); 
if($process && $process->className() == 'ProcessPageEdit') $currentPage = $process->getPage();
if(!$currentPage) return;

echo $out;

// let's create a copy
$copy = $input->post->createcustomcopy;
$title = $sanitizer->text($input->post->name);

if($copy) {

   if(!$title) {
     $this->error('You need to specify a title for the copied page!');

   $p = new Page();
   $p->template = $templates->get($currentPage->template);
   $p->parent = $currentPage->parent;

   $p->title = $title;
   //sanitize and convert to a URL friendly page name
   $p->name = $sanitizer->pageName($p->title);

   //check if name already taken within same parent. if the same name exist, don't create a new copy
   //  @note; without this line pages were being created in duplicates
   if($p->parent->child("name={$p->name}, include=all")->id) return;
   else { 
       $this->message('Created a copy of the page with the title: ' . $title);
Edited by kongondo
  • Like 2
Link to comment
Share on other sites

Following up on my post above...Say you wanted to embed a YouTube video...for whatever reason...in the page edit context..

<iframe width="420" height="315"
src="https://www.youtube.com/embed/Bohhf3aK8gU" frameborder="0" allowfullscreen>

That's it!

  • Like 1
Link to comment
Share on other sites

that is awesome!!!! exactly what i wanted, thank you very much :)

Aah, I see. That's a cool usage of the module you got there! ^-^. Using wireRenderFile() keeps the module's input clean, circumvents limit of text allowed in that field plus makes the module much more versatile. One can do all sorts of flexible includes from within the file rendered by wireRenderFile(), depending on the context. :)

yes, i'm a huge fan of wirerenderfile :)

what do you think of having your module render a file with the name of the field by default?

field "examplefield" would render /site/assets/FieldtypeRuntimeMarkup/examplefield.php
field "examplefield2" would render /site/assets/FieldtypeRuntimeMarkup/examplefield2.php

Link to comment
Share on other sites

  • 4 weeks later...

So, I tried to use RuntimeMarkup in my RepeaterMatrix and $page refers to the page that the repeater is on. I have placed the RuntimeMarkup field inside repeater entries and therefore, I can't see a way to get a reference to the Page field in the "current" repeater entry. Basically, if I can get a reference to the Page field each time it appears in the repeater, I can simply reference the field value is want from (Template2/Page2) straight from the Page field.


Link to comment
Share on other sites


I don't think this is possible out of the box. Have a read here at a similar question:


What you want is a way to get the current repeater item, basically the nth repeater. I haven't seen any way to do that without looping through all repeaters  - which wont be very efficient.

If your page field is a single page field, using a select, maybe we could use jQuery Ajax to dynamically send the id of the selected page to some template file which would then grab whatever it is you want from template 2, return that as JSON and dynamically add the markup next to the page field. I'm not sure, in your case, whether it's worth the effort going down that route.

Edited by kongondo
Link to comment
Share on other sites

Btw, above answer refers to normal repeaters. I haven't used repeater matrix before. I am wondering whether, unlike normal repeaters, will be able to give you a 'current repeater item' variable. Anybody knows? Haven't got time to test atm.

Link to comment
Share on other sites

working the first time with repeater matrix today and it is totally awesome!!

repeater items are just normal pages and you have all you need there:

current repeater-item available under $page variable;

field in your repeater-item-type = $page->yourfield;

current page, where your repeater matrix lives on = $page->getForPage();

don't know how that plays together with your module - i'm quite busy right now :)

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
  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • 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
      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
    • By FireWire
      Hello community!

      I want to share a new module I've been working on that I think could be a big boost for multi-language ProcessWire sites.

      Some background, I was looking for a way for our company website to be efficiently translated as working with human translators was pretty laborious and a lack of updating content created a divergence between languages. I, and several other devs here, have talked about translation integrations and have recognized the power that DeepL has. DeepL is an AI deep learning powered service that delivers translation quality beyond any automated service available. After access to the API was opened up to the US, I built Fluency, a DeepL translation integration for ProcessWire.
      Fluency brings automated translation to every multi-language field in the admin, and also provides a translation tool allowing the user to translate their text to any language without it being inside a template's field. With Fluency you can:
      Translate any plain textarea or text input Translate any CKEditor content (yes, with markup) Translate page names for fully localized URLs on every page Translate your in-template translation function wrapped strings Translate modules Fluency is free, and now so is DeepL
      Since this module was first built DeepL has introduced free Developer accounts that allow anyone to start using Fluency at zero cost and beginning with the version 0.3.0 release Fluency now supports free DeepL accounts. As of June 2021 DeepL supports translation to 26 languages and continues to offer more!
      Installation and usage is completely plug and play. Whether you're building a new multi-language site, need to update a site to multi-language, or simply want to stop manually translating a site and make any language a one-click deal, it could not be easier to do it. Fluency works by having you match the languages configured in ProcessWIre to DeepL's. You can have your site translating to any or all of the languages DeepL translates to in minutes (quite literally).
      Let's break out the screenshots...
      When the default language tab is shown, a message is displayed to let users know that translation is available. Clicking on each tab shows a link that says "Translate from English". Clicking it shows an animated overlay with the word "Translating..." cycling through each language and a light gradient shift. Have a CKEditor field? All good. Fluency will translated it and use DeepL's ability to translate text within HTML tags. CKEditor fields can be translated as easily and accurately as text/textarea fields.

      Repeaters and AJAX created fields also have translation enabled thanks to a JavaScript MutationObserver that searches for multi-language fields and adds translation as they're inserted into the DOM. If there's a multi-language field on the page, it will have translation added.

      Same goes for image description fields. Multi-language SEO friendly images are good to go.

      Creating a new page from one of your templates? Translate your title, and also translate your page name for native language URLs. (Not available for Russian, Chinese, or Japanese languages due to URL limitations). These can be changed in the "Settings" tab for any page as well so whether you're translating new pages or existing pages, you control the URLs everywhere.

      Language configuration pages are no different. Translate the names of your languages and search for both Site Translation Files (including all of your modules)

      Translate all of the static text in your templates as well. Notice that the placeholders are retained. DeepL is pretty good at recognizing and keeping non-translatable strings like that. If it is changed, it's easy to fix manually.

      Fluency adds a "Translate" item to the CMS header. When clicked this opens up a modal with a full translation tool that lets the user translate any language to any language. No need to leave the admin if you need to translate content from a secondary language back to the default ProcessWire language. There is also a button to get the current API usage statistics. DeepL account owners can set billing limitations via character count to control costs. This may help larger sites or sites being retrofitted keep an eye on their usage. Fluency can be used by users having roles given the fluency-translate permission.

      It couldn't be easier to add Fluency to your new or existing website. Simply add your API key and you're shown what languages are currently available for translation from/to as provided by DeepL. This list and all configuration options are taken live from the API so when DeepL releases new languages you can add them to your site without any work. No module updates, just an easy configuration. Just match the language you configured in ProcessWire to the DeepL language you want it to be associated with and you're done. Fluency also allows you to create a list of words/phrases that will not be translated which can prevent items such as brands and company names from being translated when they shouldn't

      No "translate page" - Translating multiple fields can be done by clicking multiple translation links on multiple fields at once but engineering a "one click page translate" is not feasible from a user experience standpoint. The time it takes to translate one field can be a second or two, but cumulatively that may take much longer (CKEditor fields are slower than plain text fields). There may be a workaround in the future but it isn't currently on the roadmap. No "translate site" - Same thing goes for translating an entire website at once. It would be great, but it would be a very intense process and take a very (very) long time. There may be a workaround in the future but it isn't on the roadmap. No current support for Inline CKEditor fields - Handling for CKEditor on-demand hasn't been implemented yet, this is planned for a future release though and can be done. I just forgot about it because I've never really used that feature personally.. Alpha release - This module is in alpha. Releases should be stable and usable, but there may be edge case issues. Test the module thoroughly and please report any bugs via a Github issue on the repository or respond here. Please note that the browser plugin for Grammarly conflicts with Fluency (as it does with many web applications). To address this issue it is recommended that you disable Grammarly when using Fluency, or open the admin to edit pages in a private window where Grammarly may not be loaded. This is an issue that may not have a resolution as creating a workaround may not be possible. If you have insight as to how this may be solved please visit the Github page and file a bugfix ticket.
      ProcessWire  3.0+ UIKit Admin Theme That's Fluency in a nutshell. A core effort in this module is to create it so that there is nothing DeepL related hard-coded in that would require updating it when DeepL offers new languages. I would like this to be a future-friendly module that doesn't require developer work to keep it up-to-date.
      The Module Is Free
      This is my first real module and I want to give it back to the community as thanks. This is the best CMS I've worked with (thank you Ryan & contributors) and a great community (thank you dear reader).
      DeepL Developer Accounts
      In addition to paid Pro Developer accounts, DeepL now offers no-cost free accounts. Now all ProcessWire developers and users can use Fluency at no cost.
      Learn more about free and paid accounts by visiting the DeepL website. Sign up for a Developer account, get an API key, and start using Fluency today.
      Download & Feedback
      Download the latest version here
      Github repository:
      File issues and feature requests here (your feedback and testing is greatly appreciated):
      Thank you! ¡Gracias! Ich danke Ihnen! Merci! Obrigado! Grazie! Dank u wel! Dziękuję! Спасибо! ありがとうございます! 谢谢你!

    • By tcnet
      PageViewStatistic for ProcessWire is a module to log page visits of the CMS. The records including some basic information like IP-address, browser, operating system, requested page and originate page. Please note that this module doesn't claim to be the best or most accurate.
      One of the biggest advantage is that this module doesn't require any external service like Google Analytics or similar. You don't have to modify your templates either. There is also no Javascript or image required.
      There is only one disadvantage. This module doesn't record visits if the browser loads the page from its browser cache. To prevent the browser from loading the page from its cache, add the following meta tags to the header of your page:
      <meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate" /> <meta http-equiv="Pragma" content="no-cache" /> <meta http-equiv="Expires" content="0" /> How to use
      The records can be accessed via the Setup-menu of the CMS backend. The first dropdown control changes the view mode.

      Detailed records
      View mode "Detailed records" shows all visits of the selected day individually with IP-address, browser, operating system, requested page and originate page. Click the update button to see new added records.

      Cached visitor records
      View modes other than "Detailed records" are cached visitor counts which will be collected on a daily basis from the detailed records. This procedure ensures a faster display even with a large number of data records. Another advantage is that the detailed records can be deleted while the cache remains. The cache can be updated manually or automatically in a specified time period. Multiple visits from the same IP address on the same day are counted as a single visitor.

      Upgrade from older versions
      Cached visitor counts is new in version 1.0.8. If you just upgraded from an older version you might expire a delay or even an error 500 if you display cached visitor counts. The reason for this is that the cache has to be created from the records. This can take longer if your database contains many records. Sometimes it might hit the maximally execution time. Don't worry about that and keep reloading the page until the cache is completely created.
      Special Feature
      PageViewStatistic for ProcessWire can record the time a visitor viewed the page. This feature is deactivated by default. To activate open the module configuration page and activate "Record view time". If activated you will find a new column "S." in the records which means the time of view in seconds. With every page request, a Javascript code is inserted directly after the <body> tag. Every time the visitor switches to another tab or closes the tab, this script reports the number of seconds the tab was visible. The initial page request is recorded only as a hyphen (-).

      New in version 1.1.0
      A new feature comes with version 1.1.0 which offers to record user names of loggedin visitors. Just activate "Record user names" and "Record loggedin user" in the module settings.
      You can access the module settings by clicking the Configuration button at the bottom of the records page. The settings page is also available in the menu: Modules->Configure->ProcessPageViewStat.
      This module uses the IP2Location database from: http://www.ip2location.com. This database is required to obtain the country from the IP address. IP2Location updates this database at the begin of every month. The settings of ProcessPageViewStat offers the ability to automatically download the database monthly. Please note, that automatically download will not work if your webspace doesn't allow allow_url_fopen.
      This module uses DragScroll. A JavaScript available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability in view mode "Day" to drag the records horizontally with the mouse pointer.
      This module uses the PHP class parseUserAgentStringClass available from: http://www.toms-world.org/blog/parseuseragentstring/. This class is required to filter out the browser type and operating system from the server request.
    • By clsource
      Inertia Adapter ProcessWire Module
      Hello! Long time no see.
      I created this module so you can use Inertia.js (https://inertiajs.com/) with ProcessWire.
      Inertia allows you to create fully client-side rendered, single-page apps, without much of the complexity that comes with modern SPAs. It does this by leveraging existing server-side frameworks.
      Inertia isn’t a framework, nor is it a replacement to your existing server-side or client-side frameworks. Rather, it’s designed to work with them. Think of Inertia as glue that connects the two. Inertia comes with three official client-side adapters (React, Vue, and Svelte).
      This is an adapter for ProcessWire. Inertia replaces PHP views altogether by returning JavaScript components from controller actions. Those components can be built with your frontend framework of choice.
      - https://github.com/joyofpw/inertia
      - https://github.com/joyofpw/inertia-svelte-mix-pw
      - https://inertiajs.com/

    • By sms77io
      Hi all,
      we made a small module for sending SMS via Sms77.io. It supports sending to one and multiple users.
      You can download it from GitHub and follow the instructions on how to install it - it is quite easy. An API key is required for sending, get yours for free @ Sms77 and receive 0,50 €.
      Hope this helps somebody and we are open for improvement suggestions!
      Best regards
  • Create New...