Using Gravity Forms ‘gform_user_registration_signup_meta’ PHP filter

by

The gform_user_registration_signup_meta filter allows the modification of the signup meta data. This filter is used in the User Registration Add-On for Gravity Forms.

Usage

A generic example of how to use the filter:

add_filter('gform_user_registration_signup_meta', 'your_function_name', 10, 4);

To target a specific form, append the form id to the hook name (format: gform_user_registration_signup_meta_FORMID):

add_filter('gform_user_registration_signup_meta_74', 'your_function_name', 10, 4);

Parameters

  • $meta (array): All the metadata in an array (user login, email, password, etc.).
  • $form (Form Object): The current Form object.
  • $entry (Entry Object): The Entry object (to pull the meta from the entry array).
  • $feed (Feed Object): The Feed object.

More information

See Gravity Forms Docs: gform_user_registration_signup_meta

Examples

Add a blog template

This example sets the ‘blog_template’ meta value to 1.

add_filter('gform_user_registration_signup_meta', 'add_blog_template', 10, 4);
function add_blog_template($signup_meta, $form, $entry, $feed) {
    $signup_meta['blog_template'] = 1;
    return $signup_meta;
}

Add a custom user meta

This example adds a custom user meta value from the form entry.

add_filter('gform_user_registration_signup_meta', 'add_custom_user_meta', 10, 4);
function add_custom_user_meta($signup_meta, $form, $entry, $feed) {
    $signup_meta['custom_user_meta'] = rgar($entry, '3');
    return $signup_meta;
}

Add a role based on a form field

This example sets the user role based on a form field value.

add_filter('gform_user_registration_signup_meta', 'set_user_role', 10, 4);
function set_user_role($signup_meta, $form, $entry, $feed) {
    $selected_role = rgar($entry, '5');
    $signup_meta['role'] = $selected_role;
    return $signup_meta;
}

Add a user’s first and last name

This example adds the user’s first and last name to the signup meta.

add_filter('gform_user_registration_signup_meta', 'add_user_name', 10, 4);
function add_user_name($signup_meta, $form, $entry, $feed) {
    $signup_meta['first_name'] = rgar($entry, '1');
    $signup_meta['last_name'] = rgar($entry, '2');
    return $signup_meta;
}

Add user meta based on conditional logic

This example adds user meta based on the value of a form field.

add_filter('gform_user_registration_signup_meta', 'conditional_user_meta', 10, 4);
function conditional_user_meta($signup_meta, $form, $entry, $feed) {
    $field_value = rgar($entry, '6');
    if ($field_value == 'Yes') {
        $signup_meta['special_condition'] = 'yes';
    }
    return $signup_meta;
}