Skip to main content

Showcase for the new (Plone 4) IUserDataSchema. Shows how to extend the user data fields that can be selected for the registration form.

Project description


Since Plone 4, the registration form for new users is a Zope formlib form, defined in allows the site administrator to select fields from this schema to appear on the registration form.

This product aims to show how you could extend or modify the default schema provided by, and add new fields to the registration form.

How it works

Overriding the default schema

The default schema is defined in, and is provided by a utility. We override this utility in the file profiles/default/componentregistry.xml:


Our contains:

from import IUserDataSchemaProvider

class UserDataSchemaProvider(object):

    def getSchema(self):
        return IEnhancedUserDataSchema

And, also in, we subclass the default schema:

from import IUserDataSchema

class IEnhancedUserDataSchema(IUserDataSchema):
    """ Use all the fields from the default user data schema, and add various
    extra fields.

Adding fields to the schema

The “Country” field

We can now add a schema field to our schema class:

class IEnhancedUserDataSchema(IUserDataSchema):
    # ...
    country = schema.TextLine(
        title=_(u'label_country', default=u'Country'),
                      default=u"Fill in which country you live in."),

Various other fields

There are various other extra fields with which you could extend your users’ profile. In you will find examples for:

  • a Date field (birthdate)

  • a Boolean field (newsletter)

  • a Choice field (gender)

The “Accept Terms” field

A special case is the accept field. This is a Boolean field which is required for signup. We implement it by adding a constraint to the schema:

def validateAccept(value):
    if not value == True:
        return False
    return True

class IEnhancedUserDataSchema(IUserDataSchema):
    # ...
    accept = schema.Bool(
        title=_(u'label_accept', default=u'Accept terms of use'),
                      default=u"Tick this box to indicate that you have found,"
                      " read and accepted the terms of use for this site. "),

Because this field can be ignored once registration is complete, we don’t add it to the memberdata properties (see below).

Adding fields to the memberdata properties

In profiles/default/memberdata_properties.xml, we add the fields that we want to store as properties on the member. These are all the fields we defined, except the “accept” field, which is wanted only for signup.

Default settings for registration fields

We can automatically select some fields to go on the registration form. The fields we define in profiles/default/propertiestool.xml will be on the form once the product is installed.

Of course, the site manager can modify this after installation.

Making added fields available on the Personal Information form

In order to see these properties in the Personal Information form (@@personal-information), we need to take a few extra steps. We have to override the default adapter which adapts a user object to a form. See the documentation for a detailed explanation.

To override’ default adapter, we put this in overrides.zcml:


In, we repeat (yes, this is unfortunate) the fields we defined in the schema. For example, for the firstname field, we do this:

class EnhancedUserDataPanelAdapter(UserDataPanelAdapter):
    def get_firstname(self):
        return self.context.getProperty('firstname', '')
    def set_firstname(self, value):
        return self.context.setMemberProperties({'firstname': value})
    firstname = property(get_firstname, set_firstname)

Hiding custom fields on @@personal-information view

(Supplied by Martijn Pieters on stackoverflow, thanks to Gil Forcada for drawing my attention to it on

Hiding a field from the @@personal-information form and only show it on the @@register form is not supported out-of-the-box, only the other way around.

You’ll have to customize either the one or the other form to accomplish this:

  • customize to remove your field

  • or provide a new version of to add your field there.

Here’s how I’d do it: import UserDataPanel

class CustomizedUserDataPanel(UserDataPanel):
    def __init__(self, context, request):
        super(CustomizedUserDataPanel, self).__init__(context, request)
        self.form_fields = self.form_fields.omit('acceptTerms')

Note the .omit('acceptTerms'), I had to guess at the name of your extra field. You can then register this customized panel with ZCML against your theme browser layer, or directly on your Plone site or a custom interface. Here I take the easy way out and register it for the Plone site object:


This should work for both Plone 4.0 and 4.1, as this particular class did not change.

Rendering custom fields in author.cpt

(Thanks to Bill Freeman for pointing this out on

You need to also modify if you want to be able to render your new fields in, for example, author.cpt.

Non-ASCII characters

(Thanks to Imke Brandt for pointing this out on

If you try to use the product with member data with non-ASCII characters (e.g. german ‘umlaute’), you may run into encoding problems. To solve this, I modified my for every string field that may be affected by the problem to look like this:

def get_myfield(self):
    return unicode(self.context.getProperty('firstname', ''), 'utf-8')


0.3.1 (2011-06-06)

Documentation update.

  • Rendering custom fields in author.cpt (Bill Freeman)

  • Non-ASCII characters (Imke Brandt)

  • Hiding custom fields on @@personal-information view (Martijn Pieters)

0.3 (2010-09-26)

  • Make the custom fields available only when the product is installed through Generic Setup, by overriding the utility in componentregistry.xml (Elizabeth Leddy).

  • Added a metadata.xml with a profile version.

0.2 (2010-04-12)

  • Override’ adapter class, so @@personal-information will show the extra fields defined in this product. This requires >= 1.0b7.

0.1 (2010-02-28)

  • Initial release

To do

  • Translate options for the gender field

  • Uninstalling the product currently breaks the site. An uninstall step should be added to take the fields that the product added out of the ZMI’s user properties.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

collective.examples.userdata-0.3.1.tar.gz (18.8 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page