Introduction
The Feed Meta object for the User Registration Add-On is an associative array containing the properties which determine how the add-on should process the form submission.
$feed['meta'] = array(
'feedName' => 'User Registration Feed 1',
'feedType' => 'create',
'feed_condition_conditional_logic' => true,
'feed_condition_conditional_logic_object' => array(
'conditionalLogic' => array(),
),
);
Usage
We recommend accessing the $feed meta using the rgar() or rgars() functions, e.g.:
$conditional_logic_enabled = rgars( $feed, 'meta/feedCondition' );
if ( $conditional_logic_enabled ) {
// Conditional logic is enabled for this feed.
$logic_rules = rgars( $feed, 'meta/feed_condition_conditional_logic_object/conditionalLogic/rules' );
foreach ( $logic_rules as $rule ) {
// Process each conditional logic rule.
$field_id = rgar( $rule, 'fieldId' );
$operator = rgar( $rule, 'operator' );
$value = rgar( $rule, 'value' );
// Example: Use $field_id, $operator, and $value in your logic.
}
}
Properties
- feedName string
The feed name which appears on the add-ons feeds tab.
-
feedType string
The feed action. Possible values: create or update.
-
username string
The ID of the form field containing the username.
-
first_name string
The ID of the form field containing the user’s first name.
-
last_name string
The ID of the form field containing the user’s last name.
-
displayname string
How the user’s name should be displayed publicly. Possible values: username, firstname, lastname, firstlast, or lastfirst.
-
email string
The ID of the form field containing the user’s email.
-
password string
What to use for the user’s password. Possible values: ID of a password type field, generatepass, or empty.
-
role string
The role the user should be assigned. Possible values: a role name or gfur_preserve_role (update feed).
-
userMeta array
A multidimensional array containing the fields to be mapped to the user meta. See Custom Field Properties.
-
bpMeta array
A multidimensional array containing the fields to be mapped to the BuddyPress profile fields. See Custom Field Properties.
-
sendEmail boolean
Send the password to the new user by email? Default is true.
-
setPostAuthor boolean
Send this user as the author of the post created from the submission? Default is true.
-
userActivationEnable boolean
Enable user activation? Default is false.
-
userActivationValue string
Should the user be sent an email with an activation link or will the admin manually activate the user. Possible values: email or manual.
-
feed_condition_conditional_logic boolean
Is the feed condition (conditional logic) setting enabled. Default is false.
-
feed_condition_conditional_logic_object array
An associative array containing the conditional logic rules. See the Conditional Logic Object for more details.
Multisite Properties
-
createSite boolean
Should a new site be created?
-
siteAddress string
The ID of the form field that should be used for the site address.
-
siteTitle string
The ID of the form field that should be used for the site title.
-
siteRole string
The role the user should be assigned. Possible values: a role name or gfur_preserve_role (update feed).
-
rootRole string
The role the user should be assigned on the site they registered from. This option overrides the role property. Possible values: a role name, gfur_preserve_role (update feed), or empty.
Custom Field Properties
array(
'key' => 'user_url',
'value' => '3',
)
Each custom field is an associative array containing the following properties:
- key string
The User Meta or BuddyPress field the mapped form field should be saved to. Possible values: a user meta_key, a BuddyPress field id or gf_custom.
- value string
The ID of the form field or entry meta item containing the value for this field. - custom_key string
The custom meta_key. Only used by userMeta when key is set to gf_custom.