Jump to content

Menu Builder

Recommended Posts

Update: Menu Builder 0.2.2

As of today and this version onward, ONLY ProcessWire 3.x is supported.


  1. Support for namespaced ProcessWire only (ProcessWire 3.x).
  2. Various bug fixes to getMenuItems(), breadcrumbs and saving menus in multi lingual environments (thanks for all reports in GitHub and the forums).

Available now in the modules directory.

Please note that this version does not address any PHP 7.x issues.

Screen: Menu Builder in UiKit


  • Like 1

Share this post

Link to post
Share on other sites
On 06/10/2017 at 10:16 AM, Zeka said:

Hi @kongondo

I have this setup: 

  • MenuItem1
    • Submenuitem_01( allowed children)
    • SubmenuItem_02 ( allowed children)
  • MenuItem2
    • Submenuitem_03 ( allowed children)
    • SubmenuItem_02 ( allowed children)

I'm using getMenuItems for building my menu, but the issue is that I get children of Submenuitem_02 as children only of the last Submenuitem_02 ( parent_id  =  id of the last Submenuitem_02 ), but I expected that I will get duplications of children pages with right parent_id for every Submenuitem_02

Of course, I can get children in my custom function but I think that in this case, getMenuItems doesn't work as expected and could be improved.

What do you think about it? 

Thanks, Eugene. 

Hi Eugene,

This is now sorted in version 022. Thanks.

  • Like 1

Share this post

Link to post
Share on other sites

Hi @kongondo

my client (using a multi-language site) just created a page, that is not relevant to anyone outside of Germany and therefore deactivated the english Version with ProcessWires default settings ("Active?"-checkbox behind the page url in settings) and it seems like inactive pages do not disappear in navigations built with MenuBuilder.

Is there a way to solve this, that I just didn't see or do I have to work around this?

Kind regards,

Share this post

Link to post
Share on other sites


Just to clarify, are you saying you want the German version of the page to appear in the menu but not the English one? Meaning, if viewing the site in German, we see the page in the menu, if we view it in English, we don't. No, I've never considered such a scenario but now I see I should. If we are to skip that item from the menu, if it is a parent item, obviously, its children will also be skipped. 

Share this post

Link to post
Share on other sites


this is exactly what I would like to do.
And yes, if it is a parent page, the whole branch would be invisible but I guess this is self-explanatory and maybe even a wanted behaviour in most cases. If you don't want English users to see the parent, most likely you don't want them to see the children too.

Share this post

Link to post
Share on other sites


Could you please test the following for me before I commit? I have tested using both the normal way of generating menus (render()) and using the method getMenuItems(). I have also tested with include children and it works fine. As for include children, ProcessWire internally takes care of the inactive pages (I guess because it uses a find()), so I didn't have to touch that. 

In MarkupMenuBuilder.module, please add the following code after line # 216:

if(!$p->viewable($language)) continue;

Any issues?


Share this post

Link to post
Share on other sites

Update: Menu Builder 0.2.3


  1. Fixed a bug where inactive pages in multi-language sites would still be displayed in menus. Thanks @thmsnhl

Available in modules directory.


  • Like 4

Share this post

Link to post
Share on other sites

There is another Problem with multi language, but I think this is more a general PW issue.

Steps to reproduce:

- Configure at least a second language in PW.

- As admin, work with the "other" language, not the default (Set in Admin->Profile).

- Create menus

- Switch back to default language (Set in Admin->Profile)

The titles are not set for the default language. (See screenshot).

It is the same problem when you create a field etc. in PW as a non standard language user.  The value for the default language is not being set.



Share this post

Link to post
Share on other sites


I'll have a look. I'm not sure about the ProcessWire side of things but MB itself does check for languages when installed in a multi-language site. It doesn't activate other languages when creating a menu (which are hidden pages in admin). Hence, when saving the menu it only saves the menu title as $page->title = 'My Menu'. Since no language is specified nor is there input for other languages, the title is saved to the current language's title field. When you switch to another language, there is no menu title to display since none was saved in the first place.

By the way, this is the reason why in multi-language sites, menus cannot be rendered using their titles or names. You need to pass render() the menu ID or page.

Back to the missing titles issue, it's an issue I have previously considered. Back then, I came to the conclusion that it was not worth having menu items with multi-lingual titles since I couldn't think of a scenario to justify it. Your use case demonstrates  that I need to revisit the issue. 

I'll work on this for the next version. When creating and editing menus, there will be inputs for the different languages that are available (creating) and for enabled languages (when editing) [difference here being no need to edit the title of a menu title if that language is not enabled for that menu]. 

Above means I'll have to change the way menus are created. It has been suggested before that MB should lose the textarea for input of menu titles (one-per-line). I think I'll go with a simple table (like the one used when adding custom menu items) with columns for each available language or a ul list or div with tabs for each available language (i.e., mimic ProcessWire's language title field). To create additional menus simultaneously, one would only have to click on an 'add another menu link/icon'.

This will also resolve the issue of rendering menu items using their titles in multi-language sites. If a menu title or name is passed to render(), we will look for a menu by that title in the user's language.

Sorry for the long post! Some of these are notes-to-self to be honest :P

Edited by kongondo
  • Like 1

Share this post

Link to post
Share on other sites

dear kongondo, help the beginner:

two languages on the site
connected module 0.2.3

                    $menu = $modules->get('MarkupMenuBuilder');
                    $options = array(
                        'has_children_class' => 'has_children',
                        'current_class' => 'current',
                        'menu_css_id' => 'nav_home',
                        'menu_css_class' => 'slimmenu',
                    echo $menu->render('menu', $options);

1 language - everything is fine, 2 language:

Error: Exception: No menu items found! Confirm that such a menu exists and that it has menu items. (in /var/www/***/site/modules/ProcessMenuBuilder/MarkupMenuBuilder.module line 1415)

<code>#0 /var/www/***/site/modules/ProcessMenuBuilder/MarkupMenuBuilder.module(105): ProcessWire\MarkupMenuBuilder-&gt;throwError()</code><br />
<code>#1 /var/www/***/site/templates/home.php(24): ProcessWire\MarkupMenuBuilder-&gt;render(&#039;menu&#039;, Array)</code><br />
<code>#2 /var/www/***/wire/core/TemplateFile.php(287): require(&#039;/var/www/...&#039;)</code><br />
<code>#3 /var/www/***/wire/core/Wire.php(380): ProcessWire\TemplateFile-&gt;___render()</code><br />
<code>#4 /var/www/***/wire/core/WireHooks.php(714): ProcessWire\Wire-&gt;_callMethod(&#039;___render&#039;, Array)</code><br />
<code>#5 /var/www/***/wire/core/Wire.php(442): ProcessWire\WireHooks-&gt;runHooks(Object(ProcessWire\TemplateFile), &#039;render&#039;, Ar</code></b><br /><br /><small>This error message was shown because: you are logged in as a Superuser. Error has been logged. </small></p>

What did I want to do?

Share this post

Link to post
Share on other sites
23 minutes ago, duncan said:

What did I want to do?

It's all in the documentation here :). Please also read the last couple of post above yours.


Similar to render(), the first argument is not optional and can be a Page object, a title, name or id of a menu or an array of menu items returned from a menu's menu_items field. This means that you only have to retrieve a menu once and pass that to both render() and renderBreadcrumbs()Note that for multilingual environments, you cannot pass the method a title or a name; only the other three choices will work

Since your site uses various languages, you need to pass render() either the ID of your menu, its Page object or an array of menu items. As per the post above yours, this limitation will be resolved in an upcoming update.

  • Like 2

Share this post

Link to post
Share on other sites

Hello all. It is my first time playing with MB and I am thrilled how simple it was to attache two menus (header and footer) to my current project. Now my goal is to have the menus in multilanguage and that is where something is still missing on my end. Reading carefully the manuals, I switched the rendering to menu IDs (getting them from the URL of the menu edit link) and both menus work fine. Presently I switched the default language to be Bulgarian and second - English. The issue I am having is that if I browse the default website: domain.com it shows everything in Bulgarian (which is fine). However if I point to domain.com/en/ it still shows the menu in Bulgarian instead of switching the page titles to the english version.

My menu structure is quite simple and I only added the MB to have a better understanding of its functionality so here is the structure:

-- Home
-- About
-- Services
---- Service 1
---- Service 2
---- Service 3
-- Portfolio
-- News
-- Contact us

To call the menu I am using the following rendering code:

//Building the array of options
$options = array(

'wrapper_list_type' => 'ul',// ul, ol, nav, div, etc.
'list_type' => 'li',// li, a, span, etc.
'menu_css_id' => 'menu-top-menu',// a CSS ID for the menu
'menu_css_class' => 'menu-item',// a CSS Class for the menu
'submenu_css_class' => 'sub-menu',// CSS Class for sub-menus
'has_children_class' => 'menu-item-has-children',// CSS Class for any menu item that has children
'current_class' => 'current-menu-item',

// load the module
$menu = $modules->get('MarkupMenuBuilder');// $menu is an example
// Render the menu by title
echo $menu->render(1029, $options); // calling menu by ID to allow it on multilanguage site

Is there anything I am missing here? In the MB admin if I switch the language I see the links properly changing (for english it changes the path to /en/... but the titles are kept the same...



Share this post

Link to post
Share on other sites


There are two routes how you can achieve ML menus with MB.

1. Create separate menu for every language and depending on user language pass different pages for menu render method.

2. Enable additional language for the menu ( Settings tab -> Other active languages for this menu) I think that it is what you are looking for.

  • Like 1

Share this post

Link to post
Share on other sites
1 hour ago, MilenKo said:

Is there anything I am missing here? In the MB admin if I switch the language I see the links properly changing (for english it changes the path to /en/... but the titles are kept the same...

Alternatively, just use the 'default_title' option.


default_title: Controls whether to display Menu Builder saved menu item titles/labels versus displaying pages' actual/current titles. This is useful in scenarios where, for example, you need dynamic titles such as in a multilingual environment where you would want navigation labels to change depending on the current language. The default option is to display saved titles. To instead display actual titles, set option to 'default_title' => 1 in your options array.

Switch it to 1 and you are good to go (0 means show what has been saved in MB; 1 means show the actual ProcessWire page's title for that menu item).

Share this post

Link to post
Share on other sites

Thank you @Zeka and @kongondo

It seems as it was my mistake of having enabled Other active languages of the menu after I have added the pages and for some reason the language got the same in both. After disabling the option and reenabling it, I got the tabs for Default and English language texts so it is all good now and switching properly.

So to say, it is all working fine for multilanguage site out of the box as far as the person has taken the following steps:

1. Figure out the options array and apply the proper styling to the menu.

2. While rendering the menu, do not call the menu by name but use ID as the simplest thing to do (grab the URL from the menu edit link - id=XXXX where xxxx is the ID. In the instructions it was saying to call the menu using: 

$menu = $modules->get('MarkupMenuBuilder');// $menu is an example
echo $menu->render('XXXX', $options);

However thanks to the community and the knowledge sharing here, I figured out how to fix it using the following:

$menu = $modules->get('MarkupMenuBuilder');// $menu is an example
echo $menu->render(XXXX, $options);

4. In order to enable multilanguage options, just go to Setup>Menu Builder. From there while creating or selecting an already created menu, click on the Settings tab and enable the languages you would like the menu to be translated to from the: Other languages for this menu option. Once this step is completted, every menu option would have separate tabs for every language selected.

5. Test the menu pointing to the website url in different languages, ex. /en/ , /ru/ , /de/ etc.

  • Like 2

Share this post

Link to post
Share on other sites


does anybody know, if there is a possibility to only output a certain menu level or certain siblings in the menu?
Like the begin of a start-level?


F.e. start the output at level "sub":

- parent item 1

- parent item 2 (don't output this)

- - sub item 2.1 (only show / output this)

- parent item 3


Currently used version is V 0.1.3 with ProcessWire 2.7.2


Share this post

Link to post
Share on other sites

Hi @Bacelo,

Achievable from version 0.1.5 using the getMenuItems() method  (see examples here) or from version 0.1.8 using the 'disable menu items' feature. Please note that support for ProcessWire 2.x ceased with version 0.2.2. In your case, you can upgrade Menu Builder up to version 0.2.1. and you'll be fine. If you can though, I'd advise to upgrade to ProcessWire 3.x.

  • Thanks 1

Share this post

Link to post
Share on other sites


Hi @kongondo,

thanks a lot for you answer ^-^

PW upgrade to V 3.X is not an option currently, so how / where can I download Menu Builder V 0.2.1 ?


Share this post

Link to post
Share on other sites
1 hour ago, Bacelo said:

where can I download Menu Builder V 0.2.1 ?

From the repo. Browse the repository commits and click on the commit shown in the screenshot below:


That will take you to the page where you can clone/download that version.

Edited by kongondo
added link to repo
  • Thanks 1

Share this post

Link to post
Share on other sites
On 6/4/2018 at 9:55 PM, bud said:

Hello, could someone may help me?

1. The menu builder just works fine but I am wondering if there is a way to have options for autocollapsing parts of the menu pathes as you can do with the module markup simple navigation? It would help me because my navigation is pretty large and I should not view the whole navigation tree after a fresh installation of the module.

2. The menu option "custom" works great for custom links but I have found no way to "import" a whole path of the processwire tree into the menu builder as you can do with the option "page". What could I do instead of getting all the menu items in just one by one?

3. I also tried first to use the "custom" option of the module for importing a whole items path and then switch over to the "custom" options but it seems not to be possible. 

May someone could help?


Hi @bud,

Welcome to the forums

  1. There is no auto-collapse option. You would have to code that yourself, e.g. using JavaScript. Maybe using the getMenuItems() method is best in this case.
  2. I don't understand this question. Please elaborate and/or illustrate
  3. I don't understand this question either.




Share this post

Link to post
Share on other sites

I'm still not sure I follow. Custom menu items are ones you create yourself and are external to your ProcessWire site. E.g. www.google.com, etc. I'm also not sure whether you are talking about the backend or frontend of Menu Builder.

20 hours ago, bud said:

do you have some code to share related to your default menu tree (which uses just your css) where the menu tree just opens the part of the tree which is active (for example: one parent and their children should be open and everything else closed 

There's tons out there. Please Google 'accordion menu' OR (CSS only accordion menu). Once you've found what you like, let us know here and we can help you implement it.

Share this post

Link to post
Share on other sites


You can already do all the things you've mentioned.

  1. You can add 1 or 2 or 3 or 1000 or whatever number menu items in one go.
  2. You can delete them before OR after adding them to the menu.
  3. You can reorder items after adding them to the menu (drag and drop).
  4. You can nest items after adding them to the menu (drag and drop)
  5. You can rename menu item and also change its link (custom items)

See this example...


Maybe you mean copy and paste custom links rather than entering them one by one? I think with a little JavaScript magic, that can be done..

If I'm still not getting you, you'll have to make a screengrab/video to explain what you are after,  I'm afraid.

Share this post

Link to post
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 bernhard
      I'm using this module in several projects, but it will likely not see any updates in the future. I'm not happy with it and I'm looking for ways to develop better solutions. RockTabulator was my first try, but I'm also not 100% happy with that. The tabulator library is great, but my module implementation is not. I hope to get a good solution soon, but it will be a lot of work...
      Some of you might have followed the development of this module here: https://processwire.com/talk/topic/15524-previewdiscussion-rockdatatables/ . It is the successor of "RockDataTables" and requires RockFinder to get the data for the grid easily and efficiently. It uses the open source part of agGrid for grid rendering.
      ProcessWire is awesome for creating all kinds of custom backend applications, but where it is not so awesome in my opinion is when it comes to listing this data. Of course we have the built in page lister and we have ListerPro, but none of that solutions is capable of properly displaying large amounts of data, for example lists of revenues, aggregations, quick and easy sorts by the user, instant filter and those kind of features. RockGrid to the rescue 😉 
      100k+ rows Instant (client side) filter, search, sort (different sort based on data type, eg "lower/greater than" for numbers, "contains" for strings) extendable via plugins (available plugins at the moment: fullscreen, csv export, reload, batch-processing of data, column sum/statistics, row selection) all the agGrid features (cell renderers, cell styling, pagination, column grouping etc) vanilla javascript, backend and frontend support (though not all plugins are working on the frontend yet and I don't plan to support it as long as I don't need it myself)  
      While there is an option to retrieve data via AJAX the actual processing of the grid (displaying, filtering, sorting) is done on the client side, meaning that you can get into troubles when handling really large datasets of several thousands of rows. agGrid should be one of the most performant grid options in the world (see the official example page with a 100k row example) and does a lot to prevent problems (such as virtual row rendering), but you should always have this limitation in mind as this is a major difference to the available lister options that do not have this limitation.
      Currently it only supports AdminThemeUikit and I don't plan to support any other admin theme.
      Download: https://gitlab.com/baumrock/FieldtypeRockGrid
      Installation: https://gitlab.com/baumrock/RockGrid/wikis/Installation
      Quikckstart: https://gitlab.com/baumrock/RockGrid/wikis/quickstart
      Further instructions: https://gitlab.com/baumrock/RockGrid/wikis/quickstart#further-instructions
      German Translation File: site--modules--fieldtyperockgrid--fieldtyperockgrid-module-php.json
      Changelog: https://gitlab.com/baumrock/FieldtypeRockGrid/raw/master/changelog.md
      Module status: alpha, License: MIT
      Note that every installation and uninstallation sends an anonymous google analytics event to my google analytics account. If you don't want that feel free to remove the appropriate lines of code before installation/uninstallation.
      You can contribute to the development of this and other modules or just say thank you by
      testing, reporting issues and making PRs at gitlab liking this post buying me a drink: paypal.me/baumrock/5 liking my facebook page: facebook.com/baumrock hiring me for pw work: baumrock.com  
      Support: Please note that this module might not be as easy and plug&play as many other modules. It needs a good understanding of agGrid (and JavaScript in general) and it likely needs some looks into the code to get all the options. Please understand that I can not provide free support for every request here in the forum. I try to answer all questions that might also help others or that might improve the module but for individual requests I offer paid support (please contact me via PM).
      Use Cases / Examples:
      Colored grid cells, Icons, Links etc. The Grid also has a "batcher" feature built in that helps communicating with the server via AJAX and managing resource intensive tasks in batches:

      Filters, PW panel links and instant reload on panel close:

      You can combine the grid with a chart library like I did with the (outdated) RockDataTables module:

    • By Paul Greinke
      Hi there. I wrote a custom module for one of my projects. In fact I maybe want to use my module in other projects too. In order to be variable and customizable  I need to implement some custom hooks into my module. So I can afterwards hook into the my functions in order to modify them to match the needs of the new project.
      I tried simply defining functions with the '__' prefix. But that did not work. I'm imagining something like the following:
      <?php class MyClass { public function ___someFunction() { // Do something } } // ready.php $this->addHookBefore('MyClass::someFunction', function($event) { // some customization }); Is there a way to accomplish that? 
    • By adrian
      Hi everyone,
      Here's a new module that I have been meaning to build for a long time.
      What does it do?
      Do you have a bunch of admin snippets laying around, or do you recreate from them from scratch every time you need them, or do you try to find where you saw them in the forums, or on the ProcessWire Recipes site?
      Admin Actions lets you quickly create actions in the admin that you can use over and over and even make available to your site editors (permissions for each action are assigned to roles separately so you have full control over who has access to which actions).
      Included Actions
      It comes bundled with several actions and I will be adding more over time (and hopefully I'll get some PRs from you guys too). You can browse and sort and if you have @tpr's Admin on Steroid's datatables filter feature, you can even filter based on the content of all columns. 

      The headliner action included with the module is: PageTable To RepeaterMatrix which fully converts an existing (and populated) PageTable field to either a Repeater or RepeaterMatrix field. This is a huge timesaver if you have an existing site that makes heavy use of PageTable fields and you would like to give the clients the improved interface of RepeaterMatrix.
      Copy Content To Other Field
      This action copies the content from one field to another field on all pages that use the selected template.
      Copy Field Content To Other Page
      Copies the content from a field on one page to the same field on another page.
      Copy Repeater Items To Other Page
      Add the items from a Repeater field on one page to the same field on another page.
      Copy Table Field Rows To Other Page
      Add the rows from a Table field on one page to the same field on another page.
      Create Users Batcher
      Allows you to batch create users. This module requires the Email New User module and it should be configured to generate a password automatically.
      Delete Unused Fields
      Deletes fields that are not used by any templates.
      Delete Unused Templates
      Deletes templates that are not used by any pages.
      Email Batcher
      Lets you email multiple addresses at once.
      Field Set Or Search And Replace
      Set field values, or search and replace text in field values from a filtered selection of pages and fields.
      FTP Files to Page
      Add files/images from a folder to a selected page.
      Page Active Languages Batcher
      Lets you enable or disable active status of multiple languages on multiple pages at once.
      Page Manipulator
      Uses an InputfieldSelector to query pages and then allows batch actions on the matched pages.
      Page Table To Repeater Matrix
      Fully converts an existing (and populated) PageTable field to either a Repeater or RepeaterMatrix field.
      Template Fields Batcher
      Lets you add or remove multiple fields from multiple templates at once.
      Template Roles Batcher
      Lets you add or remove access permissions, for multiple roles and multiple templates at once.
      User Roles Permissions Batcher
      Lets you add or remove permissions for multiple roles, or roles for multiple users at once.
      Creating a New Action
      If you create a new action that you think others would find useful, please add it to the actions subfolder of this module and submit a PR. If you think it is only useful for you, place it in /site/templates/AdminActions/ so that it doesn't get lost on module updates.
      A new action file can be as simple as this:
      class UnpublishAboutPage extends ProcessAdminActions { protected function executeAction() { $p = $this->pages->get('/about/'); $p->addStatus(Page::statusUnpublished); $p->save(); return true; } } Each action:
      class must extend "ProcessAdminActions" and the filename must match the class name and end in ".action.php" like: UnpublishAboutPage.action.php the action method must be: executeAction() As you can see there are only a few lines needed to wrap the actual API call, so it's really worth the small extra effort to make an action.
      Obviously that example action is not very useful. Here is another more useful one that is included with the module. It includes $description, $notes, and $author variables which are used in the module table selector interface. It also makes use of the defineOptions() method which builds the input fields used to gather the required options before running the action.
      class DeleteUnusedFields extends ProcessAdminActions { protected $description = 'Deletes fields that are not used by any templates.'; protected $notes = 'Shows a list of unused fields with checkboxes to select those to delete.'; protected $author = 'Adrian Jones'; protected $authorLinks = array( 'pwforum' => '985-adrian', 'pwdirectory' => 'adrian-jones', 'github' => 'adrianbj', ); protected function defineOptions() { $fieldOptions = array(); foreach($this->fields as $field) { if ($field->flags & Field::flagSystem || $field->flags & Field::flagPermanent) continue; if(count($field->getFieldgroups()) === 0) $fieldOptions[$field->id] = $field->label ? $field->label . ' (' . $field->name . ')' : $field->name; } return array( array( 'name' => 'fields', 'label' => 'Fields', 'description' => 'Select the fields you want to delete', 'notes' => 'Note that all fields listed are not used by any templates and should therefore be safe to delete', 'type' => 'checkboxes', 'options' => $fieldOptions, 'required' => true ) ); } protected function executeAction($options) { $count = 0; foreach($options['fields'] as $field) { $f = $this->fields->get($field); $this->fields->delete($f); $count++; } $this->successMessage = $count . ' field' . _n('', 's', $count) . ' ' . _n('was', 'were', $count) . ' successfully deleted'; return true; } }  
      This defineOptions() method builds input fields that look like this:

      Finally we use $options array in the executeAction() method to get the values entered into those options fields to run the API script to remove the checked fields.
      There is one additional method that I didn't outline called: checkRequirements() - you can see it in action in the PageTableToRepeaterMatrix action. You can use this to prevent the action from running if certain requirements are not met.
      At the end of the executeAction() method you can populate $this->successMessage, or $this->failureMessage which will be returned after the action has finished.
      Populating options via URL parameters
      You can also populate the option parameters via URL parameters. You should split multiple values with a “|” character.
      You can either just pre-populate options:
      or you can execute immediately:

      Note the “options” vs “execute” as the last path before the parameters.
      Automatic Backup / Restore
      Before any action is executed, a full database backup is automatically made. You have a few options to run a restore if needed:
      Follow the Restore link that is presented after an action completes Use the "Restore" submenu: Setup > Admin Actions > Restore Move the restoredb.php file from the /site/assets/cache/AdminActions/ folder to the root of your site and load in the browser Manually restore using the AdminActionsBackup.sql file in the /site/assets/cache/AdminActions/ folder I think all these features make it very easy to create custom admin data manipulation methods that can be shared with others and executed using a simple interface without needing to build a full Process Module custom interface from scratch. I also hope it will reduce the barriers for new ProcessWire users to create custom admin functionality.
      Please let me know what you think, especially if you have ideas for improving the interface, or the way actions are defined.
    • By joshua
      Module Directory: https://modules.processwire.com/modules/privacy-wire/
      Github: https://github.com/blaueQuelle/privacywire/
      Module Class Name: PrivacyWire
      Changelog: https://github.com/blaueQuelle/privacywire/blob/master/Changelog.md
      This module is (yet another) way for implementing a cookie management solution.
      Of course there are several other possibilities:
      - https://processwire.com/talk/topic/22920-klaro-cookie-consent-manager/
      - https://github.com/webmanufaktur/CookieManagementBanner
      - https://github.com/johannesdachsel/cookiemonster
      - https://www.oiljs.org/
      - ... and so on ...
      In this module you can configure which kind of cookie categories you want to manage:

      You can also enable the support for respecting the Do-Not-Track (DNT) header to don't annoy users, who already decided for all their browsing experience.
      Currently there are four possible cookie groups:
      - Necessary (always enabled)
      - Functional
      - Statistics
      - Marketing
      - External Media
      All groups can be renamed, so feel free to use other cookie group names. I just haven't found a way to implement a "repeater like" field as configurable module field ...
      When you want to load specific scripts ( like Google Analytics, Google Maps, ...) only after the user's content to this specific category of cookies, just use the following script syntax:
      <script type="text/plain" data-type="text/javascript" data-category="statistics" data-src="/path/to/your/statistic/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing" data-src="/path/to/your/mareketing/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="external_media" data-src="/path/to/your/external-media/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing">console.log("Inline scripts are also working!");</script> The data-attributes (data-type and data-category) are required to get recognized by PrivacyWire. the data-attributes are giving hints, how the script shall be loaded, if the data-category is within the cookie consents of the user. These scripts are loaded asynchronously after the user made the decision.
      If you want to give the users the possibility to change their consent, you can use the following Textformatter:
      [[privacywire-choose-cookies]] It's planned to add also other Textformatters to opt-out of specific cookie groups or delete the whole consent cookie.
      You can also add a custom link to output the banner again with a link / button with following class:
      <a href="#" class="privacywire-show-options">Show Cookie Options</a> <button class="privacywire-show-options">Show Cookie Options</button>  
      I would love to hear your feedback 🙂
      You can find the always up-to-date changelog file here.
    • By joshua
      As we often use Matomo (former known as Piwik) instead of Google Analytics we wanted to embed Matomo not only in the template code but also via the ProcessWire backend.
      That's why I developed a tiny module for the implementation.
      The module provides the possibility to connect to an existing Matomo installation with the classical site tracking and also via the Matomo Tag Manager.
      If you have also PrivacyWire installed, you can tell MatomoWire to only load the script, if the user has accepted cookies via PrivacyWire.
      To offer an Opt-Out solution you can choose between the simple Opt-Out iFrame, delivered by your Matomo installation, or a button to choose cookies via PrivacyWire.
      You'll find the module both in the module directory and via github:
      ProcessWire Module Directory MatomoWire @ GitHub MatomoWire @ Packagist ->installable via composer require blauequelle/matomowire I'm looking forward to hear your feedback!

  • Create New...