Jump to content


Recommended Posts

Call ProcessWire API Functions Inside STRING

Github Repo

Current status : BETA

Each called method must return string value !

I added all functions, but not tested all. I focused page(), page()->render and field properties (label, description and notes). I also tested some basic pages() api calls.

Your API calls must start with { and must end with }. For use multiple arguments inside functions, separate arguments with ~ char.

NOTE If you pass directly arguments to api {page(title)}, this call will check for requestedApiCall()->get(arguments).


processString(string, page, language);
  • Get page title
$str = "You are here : {page:title}";
echo processString($str);
  • Get page children render result
$str = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.<hr>{page:render:children}";
echo processString($str);
  • Get homepage title
$str = "You can visit our <a hre='{pages(1):url}'>{pages:get(1):title}</a>";
echo processString($str);
  • Get title field label, description or notes
$str = "Our title field properties are : label: {label(title)} - description: {description(title)} - notes: {notes(title)}";
echo processString($str);
  • Multiple examples
$str = "
    <ul class='uk-list uk-list-striped'>
        <li><b>01: GET FIELD LABEL</b> <code>&#123;label(title)&#125;</code> <b>RESULT :</b> <code>{label(title)}</code></li>
        <li><b>02: GET FIELD LABEL WITH PREFIX</b> <code>&#123;label(title~=> )&#125;</code> <b>RESULT :</b> <code>{label(title~=> )}</code></li>
        <li><b>03: GET FIELD LABEL WITH SUFFIX</b> <code>&#123;label(title~~ <=)&#125;</code> <b>RESULT :</b> <code>{label(title~~ <=)}</code></li>
        <li><b>04: GET FIELD DESCRIPTION</b> <code>&#123;description(title)&#125;</code> <b>RESULT :</b> <code>{description(title)}</code><br>
        <li><b>05: GET FIELD DESCRIPTION WITH PREFIX</b> <code>&#123;description(title~=> )&#125;</code> <b>RESULT :</b> <code>{description(title~=> )}</code></li>
        <li><b>06: GET FIELD DESCRIPTION WITH SUFFIX</b> <code>&#123;description(title~~ <=)&#125;</code> <b>RESULT :</b> <code>{description(title~~ <=)}</code></li>
        <li><b>07: GET FIELD NOTES</b> <code>&#123;notes(title)&#125;</code> <b>RESULT :</b> <code>{notes(title)}</code><br>
        <li><b>08: GET FIELD NOTES WITH PREFIX</b> <code>&#123;notes(title~=> )&#125;</code> <b>RESULT :</b> <code>{notes(title~=> )}</code></li>
        <li><b>09: GET FIELD NOTES WITH SUFFIX</b> <code>&#123;notes(title~~ <=)&#125;</code> <b>RESULT :</b> <code>{notes(title~~ <=)}</code></li>
        <li><b>10: GET PAGE TITLE</b> <code>&#123;page(title)&#125;</code> <b>RESULT :</b> <code>{page(title)}</code></li>
        <li><b>11: GET PAGE TITLE</b> <code>&#123;page:title&#125;</code> <b>RESULT :</b> <code>{page:title}</code></li>
        <li><b>12: GET PAGE RENDER TITLE</b> <code>&#123;page:render:title&#125;</code> <b>RESULT :</b> <code>{page:render:title}</code></li>
        <li><b>12: GET HOMEPAGE TITLE</b> <code>&#123;pages:get(template=home):title&#125;</code> <b>RESULT :</b> <code>{pages:get(template=home):title}</code></li>
        <li><b>13: GET HOMEPAGE TEMPLATE ID</b> <code>&#123;pages:get(template=home):template:id&#125;</code> <b>RESULT :</b> <code>{pages:get(template=home):template:id}</code></li>
echo processString($str);
  • Like 2

Share this post

Link to post
Share on other sites

Hi @ukyo - thanks for sharing this, but I must admit I am little confused. I am honestly not really sure what you are trying to achieve - no offense intended - I am probably just missing something here :)

Can you please explain how:

$str = "You can visit our <a hre='{pages(1):url}'>{pages:get(1):title}</a>";
echo processString($str);

is any better than using the API variables in a string like this:

$str = "You can visit our <a hre='{$pages(1)->url}'>{$pages->get(1)->title}</a>";
echo $str;

BTW, pages(1) and pages->get(1) are the same thing.

The other thing you might want to take a look at is the tag compiler: https://processwire.com/blog/posts/processwire-3.0-alpha-2-and-2.6.22-rc1/#new-module-file-compiler-tags which is not really what you are doing, but it's sort of related.



  • Like 2

Share this post

Link to post
Share on other sites

I missed : https://processwire.com/blog/posts/processwire-3.0-alpha-2-and-2.6.22-rc1/#new-module-file-compiler-tags I will check it.

@adrian For directly working on templates you are right. I am using same method with you.

I wrote this functional group for own my needs and want to share it with community.

I am working on a module (Component system for uikit-2 and uikit-3). At this component system, you can change lots of things by configs.

Let me explain you little, I hope you can understand me :).


Each component have index.php for component configs and template.php file for view. Also you can extend, overwrite or add new component for site specific.


I will use grid-list component as example. Here is index.php for configs.


And here is template.php file for display.


As you see above selected area, i am using processString() function for custom title and subtitle configs.

Component call on template :

co::component($finder['items'], 'grid-list', [
    'subtitle' => '{page:length} {notes(length)} // {page:cabins} {notes(cabins)} // {page:render:destinations}'

Result :


Same component call on another template :

<?= co::component($finder['items'], 'grid-list') ?>

Result :



For my component module, I can have 1 component and i can use it on all my sites with different settings and different display options. 

// 1 more example with "alert" component
co::c('alert', [
    'title' => 'You are in {page('title')}.',
	'content' => 'You need to go <a href="{pages(1200):url}">{pages(1200):title}</a> for view our products',
	'alert_style' => 'danger',
	'alert_size' => true,
	'alert_close' => true,
	'text_align' => 'center'

If you want you can call something inside body field.

Share this post

Link to post
Share on other sites

I recommend looking into template engines instead, eg. my Latte module uses a similar {$page->field} syntax. There's a lot of additional filters/macros I've made in the last 1-2 years that allows quickly building up a site (getting config strings from a textarea field, generating srcset/breadcrumb/paginator markup, truncate strings/html, add active class, etc). Plus you can use php functions also if you need. But of course other template engines could do the job too.



  • Like 1

Share this post

Link to post
Share on other sites

@tpr I don't want to use a TemplateEngine. My module meet my needs and i am ok. Thanks for your advice !

Share this post

Link to post
Share on other sites

Thank you ukyo I've tried your module and it works like a charm out of the box with my setup. Installation via Module Directory and Class Name failed tough: 



@adrian I use this module to pare content of field in a Mail.php template that I use to send mails - I want the editor to be able to translate and edit the contents of this mail – how would you suggest doing it? I'm sending mails using custom code trough Mandrill and pulling it's content from a field like so:

You are invited by {user:fullname} to join {tem}!
<a href='{invite:httpUrl}'>Click here to accept the invitation!</a>
		$template = $pages->get('/mails/invite/');

		$subject =  processString($template->header);
		$message = processString($template->render());

		$mail = wire('modules')->get('WireMailMandrill');
		$mail->to($input->whitelist('email'), $invite->firstname.' '.$invite->lastname);
		$emailFrom = wire('config')->adminEmail;
		$mail->from($emailFrom, 'Sender');
		$count = $mail->___send();


Share this post

Link to post
Share on other sites
3 hours ago, noelboss said:

how would you suggest doing it?

Are you asking how I would do it without this module because of my question above about why this module's approach is better than calling the functions directly?

I would have just written the code to parse those tags myself or I would simply the tags that are required by the editor. Maybe simply {fullname} and {invitelink} and do a simple:

$subject = str_replace('{invitelink}, $invite->link, $subject);

Or if it works better for you, then I think it's a great use case for this module :)

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 teppo
      This module tracks changes, additions, removals etc. of public (as in "not under admin") pages of your site. Like it's name says, it doesn't attempt to be a version control system or anything like that - just a log of what's happened.
      At the moment it's still a work in progress and will most likely be a victim of many ruthless this-won't-work-let's-try-that-instead cycles, but I believe I've nailed basic functionality well enough to post it here.. so, once again, I'll be happy to hear any comments you folks can provide
      How does it work?
      Exactly like it's (sort of) predecessor, Process Changelog actually consists of two modules: Process Changelog and Process Changelog Hooks. Hooks module exists only to serve main module by hooking into various functions within Pages class, collecting data of performed operations, refining it and keeping up a log of events in it's own custom database table (process_changelog.) Visible part is managed by Process Changelog, which provides users a (relatively) pretty view of the contents of said log table.
      How do you use it?
      When installed this module adds new page called Changelog under Admin > Setup which provides you with a table view of collected data and basic filtering tools See attached screenshots to get a general idea about what that page should look like after a while.
      For detailed installation instructions etc. see README.md.

    • By Gadgetto
      Status update links (inside this thread) for SnipWire development will be always posted here:
      If you are interested, you can test the current state of development:
      Please note that the software is not yet intended for use in a production system (alpha version).
      If you like, you can also submit feature requests and suggestions for improvement. I also accept pull requests.
      ---- INITIAL POST FROM 2019-05-25 ----
      I wanted to let you know that I am currently working on a new ProcessWire module that fully integrates the Snipcart Shopping Cart System into ProcessWire. (this is a customer project, so I had to postpone the development of my other module GroupMailer).
      The new module SnipWire offers full integration of the Snipcart Shopping Cart System into ProcessWire.
      Here are some highlights:
      simple setup with (optional) pre-installed templates, product fields, sample products (quasi a complete shop system to get started immediately) store dashboard with all data from the snipcart system (no change to the snipcart dashboard itself required) Integrated REST API for controlling and querying snipcart data webhooks to trigger events from Snipcart (new order, new customer, etc.) multi currency support self-defined/configurable tax rates etc. Development is already well advanced and I plan to release the module in the next 2-3 months.
      I'm not sure yet if this will be a "Pro" module or if it will be made available for free.
      I would be grateful for suggestions and hints!
      (please have a look at the screenshots to get an idea what I'm talking about)

    • By apeisa
      Update 31.7.2019: AdminBar is now maintained by @teppo. Modules directory entry has been updated, as well as the "grab the code" link below.
      Latest screencast: http://www.screencas...73-ab3ba1fea30c
      Grab the code: https://github.com/teppokoivula/AdminBar
      I put this Adminbar thingy (from here: http://processwire.c...topic,50.0.html) to modules section and to it's own topic.
      I recorded quick and messy screencast (really, my first screencast ever) to show what I have made so far. You can see it from here: http://www.screencas...18-1bc0d49841b4
      When the modal goes off, I click on the "dark side". I make it so fast on screencast, so it might seem a little bit confusing. Current way is, that you can edit, go back to see the site (without saving anything), continue editing and save. After that you still have the edit window, but if you click "dark side" after saving, then the whole page will be reloaded and you see new edits live.
      I am not sure if that is best way: there are some strengths in this thinking, but it is probably better that after saving there shouldn't be a possibility to continue editing. It might confuse because then if you make edits, click on dark side -> *page refresh* -> You lose your edits.
      When I get my "starting module" from Ryan, I will turn this into real module. Now I had to make some little tweaks to ProcessPageEdit.module (to keep modal after form submits). These probably won't hurt anything:
      if($this->redirectUrl) $this->session->redirect($this->redirectUrl); if(!empty($_GET['modal'])) $this->session->redirect("./?id={$this->page->id}&modal=true"); // NEW LINE else $this->session->redirect("./?id={$this->page->id}");   and...
      if(!empty($_GET['modal'])) { $form->attr('action', './?id=' . $this->id . '&modal=true'); } else { $form->attr('action', './?id=' . $this->id); // OLD LINE }  
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.54
      Composer: rockett/jumplinks
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy! :)
  • Create New...