Legacy Documentation

You are using the documentation for version 3.5.17. Go here for the latest version or check here for your available upgrades to the latest version.

Member XML Format¶

ExpressionEngine utilizes a special XML format for member data.

<members>
        <member>
                <username>brettb</username>
                <screen_name>Brett Bretterson</screen_name>
                <password type="md5">653132ffd94b986bf2bb806b3c67d190</password>
                <email>brett@example.com</email>
        </member>
        <member>
                <username>robr</username>
                <screen_name>Robert Robertson</screen_name>
                <password type="sha1">1b4395b877794a16a7f4db5747380dbaafc7ff18</password>
                <email>robert@example.com</email>
        </member>
</members>

The XML tags are identical to their database field counterparts from the exp_members table. All fields are allowed except for “unique_id”.

Important

The <member_id> tag will cause the import utility to overwrite any existing members with the same ID. It is generally recommended that you do not use a <member_id> tag, so when transferring users from one system to another, ExpressionEngine can automatically create new unique IDs for each member without overwriting any existing members.

Required Tags¶

There are a few tags common to every ExpressionEngine member XML file, as follows.

Root Tag¶

XML documents require a root tag surrounding all of the elements. For the ExpressionEngine member XML format, the required root tag is <members></members>.

Element Tag¶

Each XML element of your member data must be contained in a <member></member> tag block.

Member Data Tags¶

There are three required tags to form a valid member element.

<username>
<screen_name>
<email>

Password Tag¶

The <password> tag has a special attribute, type. This allows you to provide contextual information for the password.

type=¶

“text”¶

<password type="text">pa55w0id</password>

“text” type passwords are plain text, unencrypted passwords. When importing members from an XML file, ExpressionEngine will automatically encrypt “text” type passwords for you before inserting them into the database. This allows you to keep existing passwords when importing member data from a third party application that does not store encrypted passwords.

“md5”¶

<password type="md5">653132ffd94b986bf2bb806b3c67d190</password>

“md5” passwords are those that have been encrypted with an RSA Data Security, Inc. MD5 Message-Digest Algorithm (md5) hash. [RFC 1321]

“sha1”¶

<password type="sha1">1b4395b877794a16a7f4db5747380dbaafc7ff18</password>

“sha1” passwords are those that have been encrypted with a US Secure Hash Algorithm 1 (sha1) hash. [RFC 3174]

Note

If you import encrypted passwords of one type and your ExpressionEngine installation was configured with a different type of encryption, the passwords will not work, and users will need to use the “Forgot Password” link to log in.

Birthday Tag¶

The <birthday> tag is an exception to tag and database field name matching. While you can use <bday_d>, <bday_m>, and <bday_y>, the <birthday> tag and its children were created to allow for a more semantic member XML file. The <birthday> tag contains no value itself, but rather has three child elements.

<month>¶

The two digit month of the member’s birthday. Example: 02

<day>¶

The two digit day of the month of the member’s birthday. Example: 19

<year>¶

The four digit year of the member’s birthday. Example: 1977

For the above examples, a birthday element of a member XML file would look like:

<birthday>             <month>02</month>             <day>19</day>             <year>1977</year>         </birthday>

The example above would be equivalent to:

<bday_m>02</bday_m>
<bday_d>19</bday_d>
<bday_y>1977</bday_y>

ExpressionEngine® 3 User Guide

Member XML Format¶

Required Tags¶

Root Tag¶

Element Tag¶

Member Data Tags¶

Password Tag¶

type=¶

“text”¶

“md5”¶

“sha1”¶

Birthday Tag¶

<month>¶

<day>¶

<year>¶

Available Member Data Tags¶