custom fields

[UPDATE 31. October 2016]
Custom fields got merged into Core!! We are finalizing it. All open issues can be seen here and and pull requests here. You can expect it for version 3.7!!

For a long time the Joomla community has a demand for a simple but powerful custom fields feature in the core Joomla CMS. In the Joomla 2.5.x and 3.x series, the internal form library has evolved and it is now possible to build a custom fields extension around JForm and the internal plugin system of Joomla, which just works. That's why we created DPFields for our own extensions and the Joomla core extensions like the articles manager or the user manager. We soon realized that DPFields can perhaps fulfill the needs of a basic custom fields feature in Joomla. So we asked our fellow developers on the mailing list and got some positive feedback. After Allon joined the Joomla 4 architecture team, some discussions were held with the PLT members Chris Davenport and Marco Dings, if custom fields should come into Joomla 3.6 or waiting for Joomla 4. We all agreed that it would make sense to have it in the 3 series as well.


We will take the source code of DPFields 1.2.x and port it to the Joomla CMS. The name of of the custom fields extension will be com_fields and will integrate as a horizontal component. A horizontal component is new construct which will make the life of extension developers much easier in Joomla 4. But that's another story.

The component itself manages the fields for the different contexts. The fields system plugin will then hook into various events to add the custom fields to the edit forms or display them on the front. Every component in the Joomla core which can make use of custom fields will have some new menu items to manage the fields. It is a similar approach as with categories. For the beginning we will add custom fields to the articles and users.

Let's get it!

To test out the custom fields feature for Joomla, install the patch from PR #11833 or download Joomla from the custom fields branch from our fork


Let's test it!

This short tutorial will show you how to create your first custom field for an article and display it on the front with a custom field.

Create a custom field

  1. Log in on the back end.
  2. Navigate to Content -> Articles.
  3. Click on the left sidebar on Fields.
  4. Click on the New button on the top.
  5. Define a title and label.
  6. Click the Save & Close button on the top.
custom fields sidebar edit field

Create an article

  1. Log in on the back end.
  2. Navigate to Content -> Articles.
  3. Click on the New button on the top.
  4. Define a title.
  5. Open the Fields tab.
  6. Add some text on the custom field.
  7. Click the Save & Close button on the top.
edit article 

View it on the front

  1. Log in on the back end.
  2. Create an article menu item in the menu manager and select the new article.
  3. Go to the front site of your Joomla installation.
  4. Open the article.
  5. Check if the custom field is displayed.
front article 

What will come next?

After some internal testing and hopefully feedback from early-bird testers, we will create the pull request. That starts a next round of input from a wider range of Joomlers. If all goes well we hope it will be in Joomla on the J and Beyond conference. We will keep you updated on that blog how it goes.

Future of DPFields

The future of DPFields is unknown at that point, but you will always be safe as we provide a migration path. For the closer future you don't have to worry as we will keep DPFields alive and do active development of new features for it (if accepted, we will port it to core then). If com_fields will get the attention we hope within the Joomla community, then we will provide a migration path for all DPFields users and shut down the project. If not, we will keep the DPFields extension suite definitely alive. For you as user, nothing will change right now, and we will make sure you will have a neat experience, with com_fields or com_dpfields.


[UPDATE 31. April 2016]

The development of the custom fields feature moved to it's won repository at

[UPDATE 5. May 2016]

As the Joomla PLT team decided to change the version number for the version 3.5.2 to 3.6.0, com_fields will be part of Joomla 3.7.

[UPDATE 29. August 2016]

Custom fields PR #11833 has landed with over 100 issues closed, 50 pr's done and 200 commit. Please do further testing there and not on the custom fields project!

[UPDATE 31. October 2016]

Custom fields PR #11833 got merged. We are finalizing it now.

joomla airbnb

This is a guest post blog from one of our DPCalendar users who wanted to integrate Airbnb into Joomla. It's a step by step tutorial how to connect these two systems using the iCal plugin available in the DPCalendar Standard version. With DPCalendar it is possible to present a single calendar view of a users holiday rental website with the popular Airbnb accommodation rental site, this article explains the steps involved in getting it up and running.

It is assumed at this point you have read and followed our instructions for getting started and have created your local calendar. It is also assumed you have a presence on the Airbnb website and have access to the user admin section. It is also worth understanding the different types of calendars is use, we will be using both a local native view and a subscribed view see here.

There are 2 steps involved in providing a single calendar view to both sites

  • Exporting the Airbnb calendar to your jooma website, to be viewed within DPCalendar as a subscribed calendar.
  • Exporting your DPCalendar to be replicated onto your Airbnb calendar.

Step 1, export from Airbnb to DPCalendar

After this step you will have a combined view of your DPCalendar calendar and Airbnb calendar within Joomla, which will refresh from Airbnb whenever a user loads your Joomla page. Lets assume we have setup our local DPCalendar and it has a title of "Local Calendar1" and we know how to create an event and for that event to be viewed on our site either by using a menu item or perhaps the mini module, what we now want to be able to do is to overlay that view with the content from the corresponding Airbnb calendar.

First we need to logon to our Airbnb admin area and take a copy of the Uri which we will need when we setup our Ical plugin.

  • Logon to Airbnb with your admin userid.
  • Click your name in the top-right corner.
  • Select Manage Listings from the menu - which will take you to your Air BnB dashboard.
  • Select Listings from the top menu - which will display all of your accommodation listings.
  • Select the listing you need.
  • Select Pricing & Availability in the listing sub-menu..
  • Scroll down the Pricing & Availability page to the Calendar Sync section & click Export Calendar.
  • You will then see a pop up (or extra field at the bottom of the page) with the URL of the Airbnb Calendar
Airbnb reservation settings

You will then be provided with a Uri which you can now cut and paste into your Ical plugin settings.

Airbnb ics link

Now we can go back to out Joomla site and open up the DPCalendar Ical plugin and proceed as follows.

  • First ensure our plugin is enabled.
  • Select New , name your Ical calendar and paste in your Uri copied from the Airbnb site above.
  • Optionally change the colour of your calendar entries.
  • When your ready Save & Close (both the Ical entry and the plugin)
Airbnb dpcalendar ics uri

We now have a link setup from the Joomla site to the Airbnb site, now we can add the calendar feed to our local calendar. In this example I'm using the mini calendar module, but the same applies using the menu item calendar display.

  • Select the mini module item you want to use to display your combined calendars
  • Give it a suitable title (Combined Calendar worked for me)
  • In the field to Select Calendars you will be given the option to select 1 or more calendars to display in this module, these are represented as a single calendar view
  • Select your local DPCalendar AND your Airbnb calendar
Airbnb select calendars module

Step 2, export from DPCalendar to Airbnb

At this stage we now have a single view on our Joomla site of our local calendar AND the Airbnb calendar, the view of the Airbnb calendar will be refreshed when a user loads the page on our Joomla site, we now want to reflect any changes made to the DPCalendar back to the Airbnb calendar to complete the integration.

The steps to be performed are essentially the same steps as above, but instead of exporting from Airbnb, we now want to import.

First we need to obtain our DPCalendar Uri for our local native calendar, there are 2 options to find this:-

  1. If you are using a menu item to display the calendar, navigate to the menu entry and select Calendar Options Tab, ensure the option for Show Calendars is set to Yes and expand, now from the front end you will be shown the calendar name and an option to download its ICal file, at this point you can right click the ICal option and Copy Link Location, this is what we will need on the Airbnb site.
  2. Alternatively the Uri requird can be constructed as follows simply substitute your site name and the calendar id, which can be found in the back end DPCalendar Component and is the id of the native DPCalendar you want to export to Airbnb.
Airbnb check calendar

Now that we have our Uri, we can logon to our Airbnb admin area and copy the Uri into the calendar import setting.

  • Logon to Airbnb with your admin userid.
  • Click your name in the top-right corner.
  • Select Your Listing from the menu, you will now be presented with all of your listings.
  • For the listing you want to edit, click Manage Listing and Calendar.
  • You will now be shown the calendar for that specific listing.
  • Click Settings in the top-right corner of your calendar view.
  • Under Sync Calendars, select Import calendar.
Airbnb import calendar

Simply paste your Uri into the Calendar Address (URL) field, give your Calendar a name e.g. DPCalendar1 and press the Import button, the Airbnb calendar will now synch with your Joomla site and continue to do so automatically every few hours.

An entry exported from DPCalendar will appear on the Airbnb admin view as shown.

Airbnb event calendar

And on the front end guest view.

Airbnb calendar

Side notes

We now have a 2 way flow between our Joomla site and Airbnb, but there are some points worth remembering.

  • We have simply subscribed to the Airbnb calendar, therefore we do NOT maintain any of the Airbnb data on our Joomla website.
  • Airbnb has no concept of an event or a booking, therefore if you create an event in DPCalendar against the local calendar, this will be imported into Airbnb at the next cycle and will block the specific dates from the Airbnb calendar. This is regardless of whether you have made any corresponding booking within DPCalendar; therefore I suggest you only ever create an event when you make a booking within DPCalendar.
  • The Ical plugin will cache the view of the Airbnb calendar for a number of seconds which can be modified in the plugin advanced options.
  • The Airbnb calendar works on the basis that any day which does NOT have a rental price listed on the Airbnb calendar is considered to be blocked by the owner, and will export an entry for that day with the item description as "Not available" , therefore to avoid double entries. only block dates on the Airbnb calendar, and this will be reflected on your combined calendar view on your Joomla site. Similarly be creating an event/booking in DPCalendar this will be imported into Airbnb and mark the dates as blocked and unable to be booked.
  • If you subsequently unpublish or delete an event from DPCalendar, this will be picked up by Airbnb at the next automatic sync and will unblock the entry in the Airbnb calendar

gradual engagementThe advent of Web applications has an interesting effect on the venerable 4Ps of the traditional marketing mix concept (Product, Price, Place, Promotion), in that the single website (or mobile app) can be all 4 things at once. The problem is, of course, that having a single item perform multiple roles simultaneously can be tricky to handle.

For instance, a Web application’s product offering is often itself the service (or the set of services) which a particular website is offering, and hence has to be fully functional. However, newcomers to the site may not necessarily understand all the dimensions of that service, and will need to be taught how to navigate the application’s features. At the same time, the website also has to attract its target market by showcasing all the benefits of the service(s) as compared to its competitors. And above all, users have to be encouraged to sign up for the service.

So how should this juggling act be resolved? One of the more common user design (UX) patterns in use out there is called gradual engagement. In essence, gradual engagement is designed to slowly (but immediately) immerse a prospective user into interacting with the web application, by guiding the user through using the application with plenty of tooltips and helpful hints, while delaying the sign-up until towards the end. The idea is, as the name suggests, to gradually engage the user with your product or service in such a way that when the sign-up page is reached, it is seen as an almost organic and natural part of using the service – and by doing so, lowering the prospective user’s barriers towards the process.

Gradual engagement as a UX pattern has been around since the mid-to-late 2000s, and has seen a great deal of success in many scenarios. It has also been viewed with concern, because it could be seen as a form of bait-and-switch tactic if implemented incorrectly. Here are some factors to consider whether or not your website can deploy a form of gradual engagement:

Main Focus

Your web or mobile application is far more likely to benefit from using gradual engagement if it focuses on delivering a single service (e.g. Twitter), or a small set of closely-related services (e.g. Windows Central), instead of being a portal to an umbrella of not-necessarily-similar features (e.g. Microsoft Live).

Instant Gratification

Gradual engagement works well when your prospective users can see immediate results from using your web application. This allows you to build rapport quickly with them and increases their engagement with the application. It does not matter whether the ultimate fulfilment of the application comes later (e.g. online shopping), as long as the process is seen to have immediate effects (e.g. items are added to a shopping cart, which can be edited without navigating away from the main shopping page).

Low-friction Process

The easier you make it for your prospective users to get started doing what they came to you to do, the easier it will be for them to continue onwards and stay engaged with your service. Providing helpful hints and tips on the salient features of your application as they progress through will help, as will an analysis on the application’s design itself.

Many mobile games that are free-to-play (especially endless runners) use the process of gradual engagement to encourage players to keep playing and bring them on board the gaming experience. Only later, once they’ve started to enjoy the game, are they introduced to the in-app purchases or sign-in features. Which other Web or mobile applications have you seen use gradual engagement?

dpcalendar 5 3

One of the most requested feature for DPCalendar was a more enhanced ticketing workflow. In DPCalendar 5.3, we completely revamped the former attending functionality into a fully featured booking and ticketing workflow. Additionally we refactored the payment gateways to be based on Omnipay, which allows us to implement new payment gateways faster. With over 50 cases solved, working hundreds of hours on the next generation of DPCalendar, we are very proud to publish DPCalendar 5.3 to to the public! Read on about more information of the new features.

New booking and ticket system

If the user books now an event, a whole process is started to trigger payment gateways and create tickets. More notifications E-Mails (eg. to the author) are sent out with important information embedded into the mail content, the ticket is attached as PDF and the event can be imported from the mail into the mail app of the attendee. Multiple tickets can be booked and the prices are reflected directly on the booking mask.

To get a quick overview about the status of the tickets of an event, the author or the admins have a direct link to the tickets, where they can see who has paid and who not. If the author wants to invite some registered users and invite button allows to send out invitations to individual users or whole user groups. The booking is getting the state invited and the user has the possibility to decline or accept the invitation.

The ticketing system is made the way that also none registered users can book seats for events. This means that the contact to the attendee is almost lost after the booking is made. To turn your attendees into followers of your site, we implemented the concept of gradual engagement. This means that after the booking is done, DPCalendar is offering to create an account on your site, to turn the visitor into a user immediately.

front booking form 

Tickets and QR codes

After the booking is done and the tickets got paid (if needed), the attendee is getting access to the tickets itself. The attendee can change the address on the ticket and the reminder time before the event happens. Below the details a QR code is displayed. Is the ticket printed out, the guard on the event can scan it and if logged into the web site, the ticket will be marked as checked in. This means if a second visitor is coming with the same ticket, the entrance is not allowed. Additionally a ticket is getting a seat number to easily identify the place the ticket belongs to.

front ticket view

Invoices and new 2checkout payment gateway

If an event has a price set, then the visitor needs to do a payment. Payments are implemented through Joomla plugins which can be configured in the Joomla plug in manager. We supported till now manual (wire) payments, Paypal or Stripe for credit card payments. Additionally we implemented 2checkout as new payment gateway. The visitor will be redirected directly to the 2checkout site for safe payments. After the payment is done an invoice is sent to the attendee. On the new booking menu item, the user can download later the invoices again as PDF file if needed.

front invoice

What comes next

This is only the beginning of a bigger change in the attending/booking feature of DPCalendar. In 2016 we have plans to introduce multiple prices per event, add more payment gateways and to introudce new views like a resource view. Stay tuned for more cool features to come!


Beside that we fixed tons of minor bugs and did some small enhancements for a new experience for the Joomla calendar and event manager. The following list represents the full changelog of the new 5.3 version:

  • [#75]   Featured events in list and blog view
  • [#505]   Sending of invites to users or user groups
  • [#576]   Attending users list
  • [#1006]   List of bookings
  • [#2650]   Invoice and ticket to every attendee
  • [#3007]   More than one ticket per booking
  • [#3083]   Seat information per ticket
  • [#3115]   Ticket checking through QR code by the admin
  • [#3122]   2Checkout payment gateway
  • [#3123]   Gradual engagement for public visitors
  • [#1064]   Attendee (Booking) Menu Item
  • [#2322]   Notification for subscriber
  • [#2525]   Change time interval
  • [#2714]   Unable to include multiple calendars
  • [#2743]   Event Attendance emails notifications to event poster only
  • [#3055]   Basic options tab set as hidden
  • [#2924]   Set week mode like in calendar view
  • [#2931]   Options for Event list blog
  • [#2944]   Xing share button
  • [#2950]   Event ID support in content plugin
  • [#2978]   Add parameter featured=1 for featured events in content plugin
  • [#2979]   Content plugin does not include moustache code for images
  • [#2980]   List menu item description truncate
  • [#2981]   Events lacking printing options
  • [#2982]   Klicking on images should open events detail page
  • [#2988]   List view configuration in Calendar
  • [#2997]   Multiple locations sort order
  • [#3005]   iCal sync: Allowed Memory Size Error
  • [#3027]   Adapt to front renderer class of DPFields
  • [#3072]   CSV export of attendees
  • [#3076]   Events disappearing after hoover
  • [#3077]   Filter bookings by event
  • [#3103]   Logical operators filter on external events like iCal
  • [#3127]   Open event in popup on map module and map menu item
  • [#2961]   CalDAV server doesn't work on FastCGI servers
  • [#2945]   List Blog images with captions not responsive
  • [#2946]   Download of outlook.ics for series events is wrong
  • [#2952]   Latest update breaks submenu calendars
  • [#2956]   Upcomming filter no results
  • [#2960]   Tag filter in backend not apply
  • [#2972]   Popup width too small on simple layout
  • [#2984]   Notification email does not work
  • [#2985]   Facebook share popup too small
  • [#2986]   Calendar cannot be synced via CalDAV
  • [#2994]   Map does not show event locations
  • [#3009]   Problem with the import of CalDAV Calendar
  • [#3017]   htaccess causes problems
  • [#3043]   Exchange events are not updating after changes on calendar
  • [#3044]   Facebook event publishing is not working with new apps
  • [#3046]   DP fields disappearing
  • [#3094]   Copying error
  • [#3095]   Pagination and colors in backend
  • [#3134]   Public attendances are filled with previous details
  • [#3196]   GCalendar plugin produces invalid error
  • [#3006]   Print list view

Kind regards

Allon Moritz aka laoneo
Founder of Digital Peak

dpfields 1 1The aim of DPFields is to be simple to use, low learning curve and seamless integrated. So we thought what should we do next. After some interesting discussions on the Joomla Day Germany and valuable feedback from the Joomla community we are proud to ship version 1.1.0 of DPFields with some amazing new stuff. The main new feature is that fields can be categorized and the output of a field is now rendered in layouts. Read on for more details about the new features.

Field categories

When you edit an article, the custom fields of DPFields have been shown in a tab with the name "Fields". Now the admin can create "Field Categories" and assign the custom fields to these categories. On the edit mask of the article (or any other component which is integrated into DPFields), are tabs shown with the name of the category instead of the generic Fields name.

To keep backward compatibility if the field is not attached to a category, then the generic name is used as tab name.

backend field categories list backend edit article field multiple tabs

Values prepared in layouts

The fields have been rendered in their own layout file, which could be easily overridden by the site admin. But the value itself was already set. Now is the value of a field prepared in it's own layout file, which can be overridden in the template. This allows the administrator to directly interfere into the process before a field is rendered. Additionally you can create layout overrides on a per type basis. This means you can just override the SQL custom fields.

To illustrate the power of that new feature, we will give you an example. If you have an image gallery plugin installed which creates an image gallery out of images in your site which do have a specific class name, then you can create an override of the imagelist layout as described here and give it the classname the gallery plugin needs.

Fields button

DPFields renders the custom fields on the front end automatically during some Joomla event hooks. Which event is now not hard coded anymore, it can be defined in the system plugin settings. You can define that the fields should rendered directly after the title, before or after the description or not at all. Why not at all? If you want to integrate the fields into the description of the article, then you can add some easy to learn mustache code into the description and the fields will be rendered under your control. For not so techie people DPFields provides an editor button, which allows to search for custom fields and to directly enter them into the description.

backend edit article form field button


Beside that we fixed some minor bugs and did some small enhancements for a new experience for Joomla custom fields. The following list represents the full changelog of the new 1.1 version:

  • [#2970]   Categories for fields
  • [#3181]   Render fields value from layout
  • [#3183]   Adding option where to render the fields automatically
  • [#3185]   Editor button to insert fields
  • [#3104]   Yes-No field , buttons are not displayed the Joomla way
  • [#3096]   YES/NO Field for Calendar: Not Save
  • [#3100]   Community Builder can't save user with DPFields
  • [#3137]   JFile not found error when system plugin is disabled
  • [#3182]   Adding new fields shows wrong categories

Kind regards

Allon Moritz aka laoneo
Founder of Digital Peak

We use cookies on our website. Some of them are essential for the operation of the site, while others help us to improve this site and the user experience (tracking cookies). You can decide for yourself whether you want to allow cookies or not. Please note that if you reject them, you may not be able to use all the functionalities of the site.