Jump to content


Recommended Posts

It's definitely getting closer to being ready diogo.

To be honest I hadn't really thought about automatically capturing changes - I kinda thought that was already in the works here:


PTM is structured so that everything that is exported is based on the content of a parent page - all the child pages, templates, fields, page field content pages, etc. So it is designed to migrate new blocks of content. It can certainly update changes to these blocks to a live server too though.

I guess it might be possible to make what you are saying work by using "Home" as the parent page of the export, so changes to the entire site are migrated. The automatic recording of changes so that the JSON file only contains changes is obviously the tricky part :) I'll read through mindplay.dk's experience in detail and see what suggestions I can garner. Off the top of my head I am thinking that maybe a simple approach might work - use the module's config data field to store and add to an array of pages, fields, and templates that change, captured whenever they are saved. That way I am not trying to record exactly what all the changes are, but rather just that something changed and therefore we should add that page/field/template to the list of things that needs to be exported.

I'll think about it some more!

  • Like 4

Share this post

Link to post
Share on other sites

Do you added the hookable stuff we talked about already? :) 

So I could publish my module too :)

Share this post

Link to post
Share on other sites

Hey Nico,

Sorry, I haven't done that yet - I actually thought you had some more stuff to do on your module around image importing and RTE embedding.

I am super busy at the moment, but I'll see if I can get the hookable part sorted out for you in the next few days. Diogo's ideas actually got me a little sidetracked because I really want to add that functionality now too :)

I'll PM you more thoughts to avoid spamming people here.

  • Like 1

Share this post

Link to post
Share on other sites

Sorry for deviating you from your track, but it's great to hear that :)

Share this post

Link to post
Share on other sites

As someone new to Processwire, I just wanted to say what a godsend this module will be. I've just started a new site using PW and Foundation, and was wondering how I could get the blog profile integrated as part of it, without setting up all the data structures and copying code manually, and here you've done it already!

I'll still have to do all the css and a lot of php changes, but this should take care of all the field/template/page setup that I need. I can see lots of other uses for this, as a way to copy/paste bits and pieces from other sites as well.

Should I just use the blog file you've included in this thread, or would it be better to setup a dummy site with the standard blog profile, and use this module to migrate?

Great job!

Share this post

Link to post
Share on other sites

Hi Russell,

Glad you'll find it useful. It's still a bit of a work in progress, but I hope to dedicate some more time to it shortly to get the final pieces in place.

If I were you I would use the blog file included in this thread because it is already modified to work as a child page, rather than needing to be the home page. Then play with the css as needed, ideally taking the blog specific bits from the imported css files and putting them into your main css files and changing the paths in the template files to those main css files. No matter what you do you'll need to make some css changes to match your site.

Good luck and please let us know how you go.

Share this post

Link to post
Share on other sites

OK, I seem to be having a little trouble importing. I've followed the step by step you posted with the blog profile, but it keeps coming back saying

"Missing required parent page. This must be selected if you want to import the pages in addition to field and template creation."

I've tried twice, and I have selected my "Home" page, which is my top level page, 3 times. Even when I just select "fields and templates" it's still giving me the same message.

Just on the question of data or templates, I do want a clean slate, but will just templates give me everything I need to start fresh?

Here's a screenshot of my last attempt


Share this post

Link to post
Share on other sites


Really sorry about that - I made some significant changes to the form processing in the last version and it looks it was having some issues with session variables which is why it wasn't remembering the parent you selected. I have implemented a quick fix and tested the blog install at my end and it seems to be working fine here. I will revisit things properly before the next version, but please test the latest version from github and let me know how it goes.


Share this post

Link to post
Share on other sites

Thanks. Been out today. Will try tomorrow. Can I follow up on the "templates only" option? Would it be better to copy with data, and delete the data, or templates only, and then create the pages myself, using a dummy site to look at a populated version to get an idea of how it all works?

Share this post

Link to post
Share on other sites

You should use the full migration option because you want the parent blog page, the categories and tags parents etc to be created. The blog.zip only comes with 5 posts, 2 categories, and 6 tags, so a full migration and then deletion of that content would be very quick. 

Share this post

Link to post
Share on other sites

Ok just gave it a run. So far it seems like it loaded OK. The first thing that worried me was, I saw it overwrote admin.php, which kind of freaked me out. A couple other top level files it says were loaded too, but are they the ones that have gone into the markup sub-dir?

I also put it under my "articles" pages, but then it put a "blog" sub-page under that. I guess I should have done it at my home page, and then renames blog to articles? Not sure if I need to delete what was imported, and try again at the proper level, or whether it's easier to try and move the blog stuff up a level. That's the PW newbie in me talking, I'm sure a bit of reading will sort that out :)

Share this post

Link to post
Share on other sites

Yeah, no need to freak out, the admin.php that got copies across goes into the markup subdir, so it's all good :)

Ideally it should have been installed into your Home as the parent, which would have created "blog" as a child of home. I would definitely suggest trying by moving blog to have home as its parent, deleting articles and then renaming blog to articles. I think this should work just fine.

Let us know how you go.

I probably need some detailed examples with this module that show just how the structure is copied and installed. That will come (maybe a video even) once I find some time to finalized things.

Great to have you testing things though.

Share this post

Link to post
Share on other sites

Adrian, this is definitely a module a lot of people have been waiting for! Thanks for this!

Adrian, this module sounds more and more useful everytime. Next thing, you will be creating a "recording" mode that collects all changes that happen in PW during a certain period and makes it possible to export them as json to make late changes on published sites really easy! (did that sound like a suggestion?)

+1 for this one. Especially when you’re collaborating with another developer on a project it is hard to keep track with each other’s changes to templates, fields, etc. without passing on countless db dumps with every commit. It would be great to have a module–even if I think it should be a separate and specialized one–documenting such changes in importable text/json/haml files. Similar to migrations used with Rails.

  • Like 1

Share this post

Link to post
Share on other sites

Well I don't have the recording mode done yet, but thanks to Nico we now have the ability to migrate content from a Wordpress site into PW.

Firstly, this module has been renamed - now it is simply: "Migrator" https://github.com/adrianbj/ProcessMigrator so please uninstall your old one and install this new version.

The module now supports 3rd party plugin modules for migrating content from other sources. The first one is: MigratorWordpress: https://github.com/NicoKnoll/MigratorWordpress

Here's what it looks like in action. Not much action in that screenshot I know, but you can see how MigratorWordpress adds in a new data source option (a WordPress xml export file). There are instructions on exporting in the MigratorWordpress readme.


For those of you who still have access to a WordPress site, simply run WP's built in exporter, then import the resulting xml file into Migrator. At the moment the Wordpress site needs to still be live because any embedded images are installed to PW from their full existing URL.

Also if you have ideas for other plugins, please feel free to start coding :) If there is interest I'll write a guide defining what is required for the module to be recognized by Migrator and also about the JSON schema that is required.

So please test out and let us know how things go.

  • Like 10

Share this post

Link to post
Share on other sites

I have added a new option called "Changes since" in the export dialog.

This is very basic at the moment and put together quickly, but it allows you to specify a date/time which will limit the exported json to only content that has changed since then.

It's certainly not the most efficient approach in that it will export the entire page, even if just the content of one field has changed. I don't expect this should be much of an issue, but it might seem wasteful if you have a page with a lot of images or files, but you only changed one small text field, because it will copy all those images/files again.

Unlike most fields, image/file fields have created/modified fields in the DB tables, so I should be able to improve this fairly easy - something for the next version :)

  • Like 1

Share this post

Link to post
Share on other sites

Adrian pointed me to his great module today because I have to migrate a WP blog to PW. I managed to import Ryan's blog profile and with Nico's extension the posts from the WP install.

Unfortunately neither comments nor categories and tags made it from WP to PW - only the posts. Upon export I chose posts->all, categories->all, status->published. I checked the XML file and all data is there as it should but wasn't completely imported to PW.

Any ideas? 

Many thanks!

Share this post

Link to post
Share on other sites

Have you checked if the categories aren't imported or only not assigned?

FYI: Comments aren't working right now but they are WIP

Share this post

Link to post
Share on other sites


Thanks for the feedback. I have just taken a look at the test wordpress xml file Nico and I were testing with and compared it to one I exported from a different WP blog and there are differences related to tags and categories.

The test xml we were working with definitely imported both tags and categories correctly and assigned them to posts with an ASM select field perfectly, so I am sure we can get this sorted out. I will probably continue the discussion with Nico via PM, but hopefully we'll get back to you in the next couple of days with a solution.

As far as I know you are the first person to test the WP import functionality so apologies for it not going fully as expected.

Share this post

Link to post
Share on other sites

Hi adrian and nico,

many thanks for your quick and kind replies. Glad that my feedback could be helpful. Unfortunately the XML file is customer data, otherwise I would give it to you for testing purposes.

@nico no, it didn't import the categories neither the tags. I first imported the blog profile successful giving me tags and categories and than the WP-XML. But it left the categories and tags pages untouched.

Share this post

Link to post
Share on other sites

Could you try import it in a clean instalation? Without ryan's blog profile? Normally it should create everything by itself.

Share this post

Link to post
Share on other sites

Well I updated it to the new WXRparser and now it should work. Even if you are using Ryan's Blog profile. Maybe even better with it than without it :)

Share this post

Link to post
Share on other sites


not sure if we shouldn't open a new thread for that. Maybe moderation can do this in case this is the wrong place to discuss the WP importer.

However, I did try first on a clean install - with the same result: Only posts, nothing else. Therefore I thought it might have to have the blog profile first in order to install the functionality required.

Do I understand you right, that it - if everything works - the module may not only import the data from WP but will also "install" all required code to run a blog?


Share this post

Link to post
Share on other sites


did try on a clean install just a few minutes ago. Got an error. See screenshot.

Got posts, categories and tags imported. Testing.


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 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 (-).

      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 Mike Rockett
      A ProcessWire wrapper for the awesome PHP Typography class, originally authored by KINGdesk LLC and enhanced by Peter Putzer in wp-Typography. Like Smartypants, it supercharges text fields with enhanced typography and typesetting, such as smart quotations, hyphenation in 59 languages, ellipses, copyright-, trade-, and service-marks, math symbols, and more.
      It's based on the PHP-Typography library found over at wp-Typography, which is more frequently updated and feature rich that its original by KINGdesk LLC.
      The module itself is fully configurable. I haven't done extensive testing, but there is nothing complex about this, and so I only envisage a typographical bug here and there, if any.
    • By robert
      I often had the need for an overview of all used fields and their contents for a specific page/template while developing new websites without switching to the backend, so I made a small module which lists all the needed information in a readable manner (at least for me):
      Debug Page Fields
      It adds two new properties to all pages:
      $page->debugFieldValues – returns an object with all (sub-)fields, their labels, fieldtypes and values $page->debugFieldTypes – returns an object with all fieldtypes and their corresponding fields // List all values of a pages $page->debugFieldValues // List a specific field $page->debugFieldValues->fieldname // List all used fieldtypes of a page $page->debugFieldTypes I recommend using it in combination with Tracy Debugger, Ray, Xdebug etc. as it returns an object and is only meant for developing/debugging uses. 
      For now, the fieldtype support includes mostly fieldtypes I use in my projects, but can easily be extended by adding a new FieldtypeFIELDNAME method to the module. I use it with five different client installations (all PW 3.0.*), but of course there might be some (or more) field configurations which are not covered correctly yet.
      Supported fieldtypes
      Button Checkbox Color Combo Datetime Email FieldsetPage * File FontIconPicker Functional Image ImageReference MapMarker Multiplier Mystique Options Page PageIDs PageTitle Radio Repeater * RepeaterMatrix * RockAwesome SeoMaestro Table Text Textarea Textareas Toggle URL * The fields with complete subfield-support also list their corresponding subfields.
      Download the zip file at Github or clone the repo into your site/modules directory. If you downloaded the zip file, extract it in your sites/modules directory. In your admin, go to Modules > Refresh, then Modules > New, then click on the Install button for this module. As this is my first ›public‹ module, I hope I did not miss any important things to mention here.
    • By horst
      Wire Mail SMTP

      An extension to the (new) WireMail base class that uses SMTP-transport

      This module integrates EmailMessage, SMTP and SASL php-libraries from Manuel Lemos into ProcessWire. I use this continously evolved libraries for about 10 years now and there was never a reason or occasion not to do so. I use it nearly every day in my office for automated composing and sending personalized messages with attachments, requests for Disposition Notifications, etc. Also I have used it for sending personalized Bulkmails many times.

      The WireMailSmtp module extends the new email-related WireMail base class introduced in ProcessWire 2.4.1 (while this writing, the dev-branch only).
      Here are Ryans announcement.

      Current Version 0.6.0
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
      get it from the Modules Directory Install and Configure

      Download the module into your site/modules/ directory and install it.

      In the config page you fill in settings for the SMTP server and optionaly the (default) sender, like email address, name and signature.
      You can test the smtp settings directly there. If it says "SUCCESS! SMTP settings appear to work correctly." you are ready to start using it in templates, modules or bootstrap scripts.

      Usage Examples
      The simplest way to use it:
      $numSent = wireMail($to, $from, $subject, $textBody); $numSent = wireMail($to, '', $subject, $textBody); // or with a default sender emailaddress on config page This will send a plain text message to each recipient.
      You may also use the object oriented style:
      $mail = wireMail(); // calling an empty wireMail() returns a wireMail object $mail->to($toEmail, $toName); $mail->from = $yourEmailaddress; // if you don't have set a default sender in config // or if you want to override that $mail->subject($subject); $mail->body($textBody); $numSent = $mail->send(); Or chained, like everywhere in ProcessWire:
      $mail = wireMail(); $numSent = $mail->to($toEmail)->subject($subject)->body($textBody)->send(); Additionaly to the basics there are more options available with WireMailSmtp. The main difference compared to the WireMail BaseClass is the sendSingle option. With it you can set only one To-Recipient but additional CC-Recipients.
      $mail = wireMail(); $mail->sendSingle(true)->to($toEmail, $toName)->cc(array('person1@example.com', 'person2@example.com', 'person3@example.com')); $numSent = $mail->subject($subject)->body($textBody)->send(); The same as function call with options array:
      $options = array( 'sendSingle' => true, 'cc' => array('person1@example.com', 'person2@example.com', 'person3@example.com') ); $numSent = wireMail($to, '', $subject, $textBody, $options); There are methods to your disposal to check if you have the right WireMail-Class and if the SMTP-settings are working:
      $mail = wireMail(); if($mail->className != 'WireMailSmtp') { // Uups, wrong WireMail-Class: do something to inform the user and quit echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; return; } if(!$mail->testConnection()) { // Connection not working: echo "<p>Couldn't connect to the SMTP server. Please check the {$mail->className} modules config settings!</p>"; return; }  
      You can add some debug code into a template file and call a page with it:
      $to = array('me@example.com'); $subject = 'Wiremail-SMTP Test ' . date('H:i:s') . ' äöü ÄÖÜ ß'; $mail = wireMail(); if($mail->className != 'WireMailSmtp') { echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; } else { $mail->from = '--INSERT YOUR SENDER ADDRESS HERE --'; // <--- !!!! $mail->to($to); $mail->subject($subject); $mail->sendSingle(true); $mail->body("Titel\n\ntext text TEXT text text\n"); $mail->bodyHTML("<h1>Titel</h1><p>text text <strong>TEXT</strong> text text</p>"); $dump = $mail->debugSend(1); } So, in short, instead of using $mail->send(), use $mail->debugSend(1) to get output on a frontend testpage.
      The output is PRE formatted and contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection, like this one:
      Following are a ...

      List of all options and features

      testConnection () - returns true on success, false on failures

      sendSingle ( true | false ) - default is false

      sendBulk ( true | false ) - default is false, Set this to true if you have lots of recipients (50+)

      to ($recipients) - one emailaddress or array with multiple emailaddresses

      cc ($recipients) - only available with mode sendSingle, one emailaddress or array with multiple emailaddresses

      bcc ($recipients) - one emailaddress or array with multiple emailaddresses

      from = 'person@example.com' - emailaddress, can be set in module config (called Sender Emailaddress) but it can be overwritten here

      fromName = 'Name Surname' - optional, can be set in module config (called Sender Name) but it can be overwritten here

      priority (3) - 1 = Highest | 2 = High | 3 = Normal | 4 = Low | 5 = Lowest

      dispositionNotification () or notification () - request a Disposition Notification

      subject ($subject) - subject of the message

      body ($textBody) - use this one alone to create and send plainText emailmessages

      bodyHTML ($htmlBody) - use this to create a Multipart Alternative Emailmessage (containing a HTML-Part and a Plaintext-Part as fallback)

      addSignature ( true | false ) - the default-behave is selectable in config screen, this can be overridden here
      (only available if a signature is defined in the config screen)

      attachment ($filename, $alternativeBasename = "") - add attachment file, optionally alternative basename

      send () - send the message(s) and return number of successful sent messages

      debugSend(1) - returns and / or outputs a (pre formatted) dump that contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection. (See above the example code under ADVANCED DEBUG METHOD for further instructions!)

      getResult () - returns a dump (array) with all recipients (to, cc, bcc) and settings you have selected with the message, the message subject and body, and lists of successfull addresses and failed addresses,

      logActivity ($logmessage) - you may log success if you want

      logError ($logmessage) - you may log warnings, too. - Errors are logged automaticaly
      useSentLog (true | false) - intended for usage with e.g. third party newsletter modules - tells the send() method to make usage of the sentLog-methods - the following three sentLog methods are hookable, e.g. if you don't want log into files you may provide your own storage, or add additional functionality here

      sentLogReset ()  - starts a new LogSession - Best usage would be interactively once when setting up a new Newsletter

      sentLogGet ()  - is called automaticly within the send() method - returns an array containing all previously used emailaddresses

      sentLogAdd ($emailaddress)  - is called automaticly within the send() method
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
    • By Cybermano
      Food Allergens Module
      A simple List of Food Allergens
      My needs were to provide a simple list of food allergens for our clients with restaurant related activity.
      The idea was to simply output the list (to speed up the data entry) without leaving the food menu editing, eg. opening another page in new tab or window.
      This isn't a perfect solution, but it works fine for my needs and I decided to share the base idea.
      This could also be easily used to show little notes or short "vademecum", not only for the list of food allergens.
      Main features
      The basis
      All moves from a short editing of the module in this tutorial: How to create custom admin pages by @bernhard
      First of all it creates an empty admin page, with a dedicated permission to let safe-user to see it (this permission has to be created as a new ones, manually or by the module).
      Once the page is created, I have hooked its behaviour into the ready.php, to show the content (basically a list).
      A step further
      With the tips of  @bernhard, @Soma (and many others), see here , the magic happens. 
      The new page will be shown as a panel, so editors will not abandon their data entry to have a quick view to the list.
      A little further
      Why scroll to the top of the page to click a link?
      The next step was to create a sticky button only in the food menu pages.
      Again with a @bernhard tip I moved into the customization of this simple module and the related hook.
      How to use this module
      After installed, it creates the page /admin/page/allergens/ and the module is to be setted up. The first field is a CKEditor with multi-language. This is the place where to write the informations that will be shown into the page. The next field is a simply text-area where to place a bit of JS that will be appended to the markup of the text (omit the 'script' tags). I also putted a checkbox with a silly statement: this to think at least twice on the safety of the written JS. Now comes the first way to display the link to the page
      Field Note with Link. Enable and save it. The module will display a new row with 4 selects (1 standard and 3 ASM):
      View mode (to show the page as Panel or as Modal PopUp); Templates to select: select one or more and save before proceed, so the  asm-select of the pages will be populated showing all the pages of the selected templates. Pages to select: also here select at least one and save before proceed to populate the asm-select for fields only with the ones that belong to the selected pages. Select the fields where to place the note and save again. That's all: now you will find into the notes of the selected fields the link "See the List of Allergens".
      At the same way, the option for the sticky button, but with a plus
      The field select is obviously unnecessary, but you could play with the last row: the inline styles to fix your sticky button where you like. Here you could set the sticky position of the <div> and the absolute ones of the <a>.

      Video Explanation
      In these screencasts you could see a custom JS that show a "copy" button near a "hanna-code" call.
      This because I've set a specific one for each allergen to show up a tooltip in the front end.

      Registrazione #33.mp4  

      Registrazione #34.mp4 ---
      Last but not the least
      Actually it works fine for my needs, even if it's much improvable: I'm working on the permissions creation, the uninstall section, a separate configs and defaults and how to include the hook into the module leaving free the ready.php. According to a simpler uninstall. Also I would make the link text as a dynamic text field, so it will be more flexible.
      I always learn a lot here, so I would share my code for whom it could be interested.
      I removed the hanna code references, but I provide you the html list of the allergens, English and Italian too, so you can paste them into the "source" of the CKEditor field to have a ready to use module.
      Obviously you are free to modify the code as per your needs.
      Please, keep in mind that I'm not a pro coder and I beg your pardon for my verbosity (speaking and coding). 😉
      I hope be helpful or for inspiration.
  • Create New...