Jump to content

Module: Image Extra


Recommended Posts

10 hours ago, justb3a said:

One opportunity would be to use a `label` element if it isn't a multilingual site and a `strong` tag if it is one.  What do you think?

Sounds good, thanks.

10 hours ago, justb3a said:

The idea behind this was that some textformatter like "NewLineToBreak" or "NewLineToListItem" doesn't make that much sense applied to an one liner input element.

True, but the textformatter that I'm thinking of is HTML Entity Encoder, which is important for any text field to avoid ambiguous ampersands or other invalid HTML. The string could be manually encoded in the template but more convenient to set-and-forget with a textformatter. :)

Link to comment
Share on other sites


Thanks so much - that makes sense... I've tried to combine the below in a lot of different ways but keep getting an error...

Any ideas?


if ($image->caption){
    //Output markup 1
else {
    //Output markup 2

<?foreach($page->images as $image) {
 $thumb = $image->width(1040); 
echo "<li><img src='$thumb->url' alt='$image->description'><p class='caption'><strong>{$image->imagetitle}</strong> <em>{$image->imagetext}</em> <span><br>{$image->role}</span></p></li>";}


Edited by kongondo
Mod Note: Moved your question to this module's support forum
Link to comment
Share on other sites

  • 2 weeks later...

thanks for this great module!

today I experienced a strange issue when using this module with the Video Fieldtype Module
I get the following error when uploading a video, when the image extra module is installed:

<br />
<b>Notice</b>:  Trying to get property of non-object in <b>/www/htdocs/w00dd152/projekte/jp-relaunch/site/modules/ImageExtra/ImageExtra.module</b> on line <b>722</b><br />
[{"error":false,"message":"Added file: portfolio_screencap_02.mp4","file":"\/jp-relaunch\/site\/assets\/files\/1162\/portfolio_screencap_02.mp4","size":3214711,"markup":"<li id='file_c17b44756649023a42ba014c5b29202c' class='InputfieldFile InputfieldImage InputfieldVideo ui-widget'>\n\t\t<p class='InputfieldFileInfo ui-widget ui-widget-header'>\n\t\t\t<span class='ui-icon ui-icon-arrowthick-2-n-s'><\/span>\n\t\t\t<span class='InputfieldFileName'>portfolio_screencap_02.mp4<\/span> \n\t\t\t<span class='InputfieldFileStats'>• 3,139 kB • <\/span> \n\t\t\t<label class='InputfieldFileDelete'><input type='checkbox' name='delete_video_repeater1162_c17b44756649023a42ba014c5b29202c' value='1' \/><span class='ui-icon ui-icon-trash'>Delete<\/span><\/label>\n\t\t\t<a class='InputfieldFileMove InputfieldFileMoveBottom' href='#'><span class='ui-icon ui-icon-arrowthickstop-1-s'><\/span><\/a> \n\t\t\t<a class='InputfieldFileMove InputfieldFileMoveTop' href='#'><span class='ui-icon ui-icon-arrowthickstop-1-n'><\/span><\/a> \n\t\t<\/p>\n\t\t\t<div class='InputfieldFileDescription'><label for='description_video_repeater1162_c17b44756649023a42ba014c5b29202c' class='detail'>Description<\/label><input type='text' name='description_video_repeater1162_c17b44756649023a42ba014c5b29202c' id='description_video_repeater1162_c17b44756649023a42ba014c5b29202c' value='' \/><\/div>\n\t\t<br \/><label class='InputfieldFileDescription'><span class='detail'>Subtitles<\/span>\n\t\t<br \/><br \/>In templates, you can access this subtitles file (portfolio_screencap_02.srt) using: <code>$page->video->eq(0)->subtitles<\/code><br \/>In templates you can access a formatted transcript (converted from subtitles entered in SRT format), by using: <code>$page->video->eq(0)->transcript<\/code>\n\t\t<br \/><br \/><textarea rows='10' name='subtitles_video_repeater1162_c17b44756649023a42ba014c5b29202c' \/><\/textarea>\n\t\t\t<input class='InputfieldFileSort' type='text' name='sort_video_repeater1162_c17b44756649023a42ba014c5b29202c' value='0' \/>\n\t\t<\/p><\/li>","replace":false,"overwrite":0}]

I testes this in PW 3.0 with the newest versions of both modules installed.
Not sure why its even interfering with the video field..
When I disable the image extra module, everything works fine.

Link to comment
Share on other sites

20 hours ago, adrian said:

@jploch - I'd like to see a dump of $event after line 718 because $field is not an object and it should be.

That said, a quick fix might be to change the hook on line 97 to:



Thx! this fixed it for me

  • Like 1
Link to comment
Share on other sites

@Jon E 

Just use the comparison inside the foreach loop:

foreach ($page->images as $image) {
  $caption = '';
  if ($image->imagetitle) {
    $caption = "<p class='caption'>{$image->imagetitle}</p>";

  echo "<li><img src='{$image->width(1040)->url}' alt='{$image->description}'>$caption</li>";

Or if you want to combine multiple parts: you can check every extra field individually and concatenate the caption before outputting it.

foreach ($page->images as $image) {
  $caption = '';
  if ($image->imagetitle) $caption .= "<strong>{$image->imagetitle}</strong>";
  if ($image->imagetext) $caption .= "<em>{$image->imagetext}</em>";
  if ($image->role) $caption .= "<span>{$image->role}</span>";
  if ($caption) $caption = "<p class='caption'>$caption</p>";

  echo "<li><img src='{$image->width(1040)->url}' alt='{$image->description}'>$caption</li>";


  • Like 1
Link to comment
Share on other sites

  • 2 weeks later...

Hi there! And, as always, thanks for a perfect product!

Would like to discuss an interesting case. Let's suppose we have some images attached to different pages, each image having some extra fields including uid field which is unique. We have to build an api page which should receive requests like /api?uid=efv97yg and it should return some JSON about the image with that uid.

Is there any possibility to find an image by its extrafield value (e.g. uid)? Well, i know that we can do something like this:

$pages_ = $pages->find('template=page_with_fotos');
foreach($pages_ as $page_)
	$images = $page_->images;
	foreach($images as $image)
		if($image->uid !== $uid) continue;
		$json = json_encode($image);
echo $json;

But its not very elegant.

And even worse:

$sql = "select * from field_foto where uid=$uid";
$query = $database->prepare($sql);

What is on my wishlist:

//pseudocode, will NOT work for sure!

$foto = $field_fotos->get("uid=$uid");

Will appreciate any advice. Thanks!

Link to comment
Share on other sites

  • 5 weeks later...

Just used this module for adding a video link to images. There was a glitch that there was no indication on the thumbnails whether there is a link added or not, so I put together a small js/css combo to add an icon:


Here is the corresponding code - dirty but works :)


var fieldname = 'video_url_project_images';

function updateVideoItems() {


    $('input[id*="video_url_project_images"][value!=""]').each(function() {

        var $item = $(this),
            seekId = $item.attr('id').replace(fieldname, 'file'),
            $target = $('#' + seekId);

        if($target.length) {

$(document).ready(function() {

$(document).on('keyup change', 'input[id*="' + fieldname + '"]', function() {

.gridImage__hover.has-video .gridImage__inner::after {
    content: "";
    position: absolute;
    right: 2px;
    bottom: 2px;
    width: 30px;
    height: 30px;
    background: #333 url('/site/templates/images/icons/play-circle.svg') center center no-repeat;
    background-size: 30px;
    border-radius: 100%;
    border: 2px solid white;
    background-clip: content-box;



  • Like 1
Link to comment
Share on other sites

  • 2 months later...

There are two different ways to get the label of any input Field:

echo "This is the field label: {$page->fields->get("simple_slider")->label}";
echo "This is the field label: {$page->fields->get("simple_slider")->getLabel()}";

Let's pretend I added to my image field an extra field "location" with the label "This was in:". So if I want the value of the "location" field I do it like this:

echo "This is was in: {$page->simple_slider->location}";
// Outputs "Barcelona"

How can I get the LABEL of the location field?

Something like:

// not working code:
echo "{$page->fields->get("simple_slider")->location->getLabel()}: {$page->simple_slider->location}";
// Should output "This was in: Barcelona"


Link to comment
Share on other sites


since extra fields aren't regular ProcessWire fields you cannot access the labels using `->getLabel()` method or `->label` property.
The extra field labels are saved in the regarding field settings (table fields, column data) using json and looks like this:


You can get the label using this functionality:

$fieldSettings = $fields->get('images')->otherFieldSettings;
$settings = json_decode($fieldSettings);
echo $settings->cf_label->cf_label__location;

As you can see there is no error handling or fallback strategy. Therefore I updated the module and added a method called getExtraLabel()

Usage example:

// outputs something like: "Location: Munich"
echo $image->getExtraLabel('location') . ': ' . $image->location;

// outputs something like: "Ort: München"
echo $image->getExtraLabel('location', 'de') . ': ' . $image->location;


  • Like 3
Link to comment
Share on other sites

  • 3 weeks later...
  • 2 weeks later...

Thank you for the module!

I'm using it to add a Markdown enhanced captions for some blog images. I have a problem - the text is processed by the Mardown module only for the first image (in ProcessWire 3.0.72 multi language).
Could someone give me a hint about where to look, please? I'm stumped.
I'm retrieving them like this:

<?php foreach (pages('parent=8888') as $item) { ?>

        <div class="uk-card uk-card-default">

            <?php if (count($item->images)) {
                      $item_image = $item->images->getRandom(); ?>

                <div class="uk-card-media-top">
                        <img src="<?=$item_image->size(580, 384, ['quality' => 75])->url?>"
                        <figcaption class="uk-text-meta uk-padding uk-padding-remove-vertical"><?=$item_image->caption?></figcaption>

            <?php } ?>

            <div class="uk-card-body">
                <h3 class="uk-card-title"><a href="<?=$item->url?>" title=""><?=$item->title?></a></h3>

<?php } ?>


Link to comment
Share on other sites

OK, found the culprit, is the static variable


which is set to true at line 527 (module version 106):

525  public function formatExtraValue(HookEvent $event) {
526    if (!self::$alreadyFormatted) {
527      self::$alreadyFormatted = true;

I don't know its purpose, but in my case (a loop retrieving captions for an image from every blog post) it stops the text formatter from processing any item after the first one. So I commented it out, I'll see if anything goes wrong.

Link to comment
Share on other sites

@geedamed I took me some time but I figured out, what the problem might be. I found a fix, but I do not understand exactly why this is happening. So if anybody could explain this behaviour, feel free to share it :)

 I added the `already formatted` check because in some cases the formatter was called twice (which could break the output). Let's define `in some cases`:

  • images are outputted on the same page as saved to
  • it just counts for the first/one image field

I compared the passed HookEvents. The only difference was that in the first argument, which contains the current Page object, the page title was missing.
So I added a check whether the Page object does contain a title, otherwise skip the formatter. I tested different cases (multiple images, multiple image fields, output from another page and so on). Seems to work – or every extra field the formatter is only called once. 

Link to comment
Share on other sites

On 03/09/2017 at 11:43 PM, PWaddict said:

Hi @justb3a I just found your module and I was wondering if you could add a cropping option field with all of it's values: northwest, north, northeast, west, center, east, southwest, south, southeast.

@PWaddict: There is already a module for cropping images: CroppableImage3

On 04/09/2017 at 10:29 PM, theo said:

Very useful Module.

Is there a way to hide / unpublish a single image temporarily instead of deleting (trashing) the entire image + information?

A checkbox for this would be great.

Thank you.

@theo: Actually the core/module do support it in a way that's not immediately obvious or as straightforward as checking a checkbox, but it's still quite useful and worthwhile when you need the capability. You could use tags or any other image extra field to achieve this. 

  1. Edit any existing files/images field, or create a new one.

  2. When editing the field settings,  check the box to enable “tags”, or create a new extra field named “hidden“ or something like that.

  3. In the “tags” or “hidden“ field for the image (which should be unpublished), enter a specific phrase like “hidden" (tags field)  or “1“ (hidden field).

  4. Now you need to check if the file should be shown on the front-end of your site. Here's how you do that:

// tag usage example
if (!$image->hasTag('hidden')) echo "<img src='$image->url' alt=''>";

// extra field hidden example
if (!$image->hidden) echo "<img src='$image->url' alt=''>";


You could also send a feature request to add this as a core feature (so you do not need to check manually whether the image is hidden and as an extra bonus the hidden images would be visible at first glance using opacity to indicate that).

  • Like 1
Link to comment
Share on other sites

  • 4 weeks later...
  • 3 weeks later...

I'm having an issue with the module. When I add an additional field to an existing image field and try to edit the page I get an error like:

SQLSTATE[42S22]: Column not found: 1054 Unknown column 'field_headerImage.title' in 'field list'

I get a similar but more verbose error on the frontend trying to view the page.

Removing the additional field resumes normal behaviour for the page.

I have other fields that I've added a title field to that work fine, so it's worked in the past, and image fields that already have custom fields have no problem, but I can't add more.

I'm working with the latest build of PW (3.0.79)

Link to comment
Share on other sites

On 17/02/2016 at 9:33 PM, justb3a said:

Could you please try to rename the field so that it doesn't contain camelCase (capital letters)? For example field_backgroundImages to field_background_images. Have a look at the description: "Any combination of ASCII letters [a-z], numbers [0-9], or underscores (no dashes or spaces)."

Please rename headerImage to header_image (or something like this) and try again.

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 monollonom
      Github: https://github.com/romaincazier/PageMjmlToHtml
      Modules directory: https://processwire.com/modules/page-mjml-to-html/
      A module allowing you to write your Processwire template using MJML and get a converted HTML output using MJML API.
      This is considered to be in alpha and as such needs some testing before being used in production!

      Created by Mailjet, MJML is a markup language making it a breeze to create newsletters displayed consistently across all email clients.
      Write your template using MJML combined with Processwire’s API and this module will automatically convert your code into a working newsletter thanks to their free-to-use Rest API.
      For this module to work you will need to get an API key and paste it in the module’s configuration.
      Once your credentials are validated, select the template(s) in which you’re using the MJML syntax, save and go visualize your page(s) to see if everything’s good. You will either get error/warning messages or your email properly formatted and ready-to-go.
      From there you can copy/paste the raw generated code in an external mailing service or distribute your newsletter using ProMailer.
      The MJML output is cached to avoid repetitive API calls Not cached if there are errors/warnings Cleared if the page is saved Cleared if the template file has been modified A simple (dumb?) code viewer highlights lines with errors/warnings A button is added to quickly copy the raw code of the generated newsletter Not added if the page is rendered outside of a PageView Only visible to users with the page’s edit permission A shortcut is also added under “View” in the edit page to open the raw code in a new tab Multi-languages support
      The code viewer is only shown to superusers. If there’s an error the page will display:
      Only its title for guests Its title and a message inviting to contact the administrator for editors If you are using the markup regions output strategy, it might be best to not append files to preserve your MJML markup before calling the MJML API. This option is available in the module’s settings.
    • By Marco Ro
      Hi guys!
      I'm a bit anxious because this is the first module I present! (beta modulo) But I will finally be able to share something with the community too! :)
      This is a BETA version of the PayPal payment system called: PayPal Commerce Platform.
      It is an advanced system (Business Pro account is needed) that brings various benefits in terms of fees and above all integrates direct payment with credit/debit cards. 
      The module integrates with Padloper 0.0.2, which is the current installation I'm using.
      This system integrates the classic PayPal buy button, the alternative or local payment method and the new payment system: credit/debit cards that doesn't go through the PayPal account. It is a Stripe-style payment, it connects directly with the bank and integrates 3D security validation.
      I say that it is a BETA because this module currently only works with Sandbox account, to put it live you need to change API url manually (manually for the moment).
      Because this module is not ready for live:
      I would like to have your opinion on how I built the module (is the first one I do). I don't want to share something that is not fish but I need a comparison with someone more experienced than me, for be sure that this is the best way to code the module.
      If you want to try this I created a git, you will find all the instructions for installation and correct operation. (Git has a MIT licensed)
      https://github.com/MarcooRo/processwire-PayPal-Commerce-Platform I hope I did something that you guys can like :)
    • By monollonom
      (once again I was surprised to see a work of mine pop up in the newsletter, this time without even listing the module on PW modules website 😅. Thx @teppo !)
      Github: https://github.com/romaincazier/FieldtypeQRCode
      Modules directory: https://processwire.com/modules/fieldtype-qrcode/
      A simple fieldtype generating a QR Code from the public URL of the page, and more.
      Using the PHP library QR Code Generator by Kazuhiko Arase.

      In the field’s Details tab you can change between .gif or .svg formats. If you select .svg you will have the option to directly output the markup instead of a base64 image. SVG is the default.
      You can also change what is used to generate the QR code and even have several sources. The accepted sources (separated by a comma) are: httpUrl, editUrl, or the name of any text/URL/file/image field.
      If LanguageSupport is installed the compatible sources (httpUrl, text field, ...) will return as many QR codes as there are languages. Note however that when outputting on the front-end, only the languages visible to the user will be generated.
      Unformatted value
      When using $page->getUnformatted("qrcode_field") it returns an array with the following structure:
      [ [ "label" => string, // label used in the admin "qr" => string, // the qrcode image "source" => string, // the source, as defined in the configuration "text" => string // and the text used to generate the qrcode ], ... ] Formatted value
      The formatted value is an <img>/<svg> (or several right next to each other). There is no other markup.
      Should you need the same markup as in the admin you could use:
      $field = $fields->get("qrcode_field"); $field->type->markupValue($page, $field, $page->getUnformatted("qrcode_field")); But it’s a bit cumbersome, plus you need to import the FieldtypeQRCode's css/js. Best is to make your own markup using the unformatted value.
      Static QR code generator
      You can call FieldtypeQRCode::generateQRCode to generate any QR code you want. Its arguments are:
      string $text bool $svg Generate the QR code as svg instead of gif ? (default=true) bool $markup If svg, output its markup instead of a base64 ? (default=false) Hooks
      Please have a look at the source code for more details about the hookable functions.
      $wire->addHookAfter("FieldtypeQRCode::getQRText", function($event) { $page = $event->arguments("page"); $event->return = $page->title; // or could be: $event->return = "Your custom text"; }) $wire->addHookAfter("FieldtypeQRCode::generateQRCodes", function($event) { $qrcodes = $event->return; // keep everything except the QR codes generated from editUrl foreach($qrcodes as $key => &$qrcode) { if($qrcode["source"] === "editUrl") { unset($qrcodes[$key]); } } unset($qrcode); $event->return = $qrcodes; })
    • By Sebi
      AppApiFile adds the /file endpoint to the AppApi routes definition. Makes it possible to query files via the api. 
      This module relies on the base module AppApi, which must be installed before AppApiFile can do its work.
      You can access all files that are uploaded at any ProcessWire page. Call api/file/route/in/pagetree?file=test.jpg to access a page via its route in the page tree. Alternatively you can call api/file/4242?file=test.jpg (e.g.,) to access a page by its id. The module will make sure that the page is accessible by the active user.
      The GET-param "file" defines the basename of the file which you want to get.
      The following GET-params (optional) can be used to manipulate an image:
      width height maxwidth maxheight cropX cropY Use GET-Param format=base64 to receive the file in base64 format.
    • By MarkE
      This fieldtype and inputfield bundle was built for storing measurement values within a field, rendering them in a variety of formats and converting them to other units or otherwise modifying them via the API.
      The API consists of a number of predefined functions, some of which include...
      render() for rendering the measurement object, valueAs() for converting the value to another unit value, convertTo() for converting the whole measurement object to different units, and add() and subtract() for for modifying the stored value by the value (converted as required) in another measurement. In the admin the inputfield includes a checkbox (which can be optionally disabled) for converting values on page save. For an example if a value was typed in as centimeters, the unit was changed to metres, and the page saved with this checkbox selected, said value would be automatically converted so that e.g. 170 cm becomes 1.7 m.

      A simple length field using Fieldtype Measurement and Inputfield Measurement.
      Combination units (e.g. feet and inches) are also supported.
      Please note that this module is 'proof of concept' at the moment - there are limited units available and quite a lot of code tidying to do. More units will be added shortly.
      See the GitHub at https://github.com/MetaTunes/FieldtypeMeasurement for full details and updates.
  • Create New...