Edit WordPress user profile with Gravity Forms

For the sake of this example I will only use three fields, the users first and last name, display name and the website, but it’s not hard to add other fields as well.

Create the Gravity Forms form

We will create a form called “Edit profile”, nothing fancy happening here.

We create the three fields we want to edit:

• First and Last name
• Display name
• Users website

When we create the fields we need to add a class to each field, we will be using that class name to identify the field. We could use the Field ID, but if we ever change the form, these field could possible change. We also need to set the option that the fields can be populated dynamically and enter the parameters we want to use for these fields.

First and Last name
We give this field the title “Name” and use the normal format.
Fill the rest as shown in the screen shot.

Display name
We give this field the title “Display name publicy” and remove the default values in the drop down.
Fill the rest as shown in the screen shot.

Users website
We give this field the title “Website”.
Fill the rest as shown in the screen shot.

Create a page

This is the easy part, in WordPress you need to create a page and insert the above form.

Write the needed code

All the code can be added to your theme’s functions.php

Set up action and filters

GF_setup_actions_filters();

/**
 * All actions and filters
 */
function GF_setup_actions_filters() {
	$_gf_edit_profile_id =  RGFormsModel::get_form_id('Edit profile');
	add_filter('gform_pre_render_' . $_gf_edit_profile_id, 'GF_populate_profile_fields');
	add_action('gform_after_submission_' . $_gf_edit_profile_id, 'GF_update_profile', 100, 2);
}

Explanation of the above code.

• Line 07: Get the ID of the form by using it’s name. This is the title we gave the form when we create it in Gravity Forms.
• Line 08: This filter will only run for the selected form and call the function that will populate the fields before it is displayed.
• Line 09: This action is done after the user presses the submit button and calls the function that will update the the WordPress meta fields.

Some helper functions

/**
 * Setup the fields
 *
 * @return array
 */
function GF_get_profile_fields ()
{
	$_fields['first_name'] = array ( 'gf_index' => '1.3', 'wp_meta' => 'first_name' );
	$_fields['last_name'] = array ( 'gf_index' => '1.6', 'wp_meta' => 'last_name' );
	$_fields['display_name'] = array ( 'gf_index' => '3', 'wp_meta' => 'display_name' );
	$_fields['website'] = array ( 'gf_index' => '8', 'wp_meta' => 'user_url' );
	return $_fields;
}

Explanation of the above code
This is an array that makes it easier for the other functions.

• The array key corresponds with the parameter name we gave the field
• The “gf_index” is the “Field ID” of the fields as shown in the screenshots. The first and last name have special indices, the 1 indicates the “Field ID”, the .3 and .6 represent the First and Last name respectively.
• The “wp_meta” corresponds with the meta value as they exist in WordPress

Populate the fields

/**
 * Populate the fields before display
 *
 * @filter gform_pre_render_
 */
function GF_populate_profile_fields ($form)
{
	$_gf_fields = GF_get_profile_fields();
	$_profileuser = wp_get_current_user();

	foreach ($form['fields'] as &$field) {

		if (strpos($field['cssClass'], 'profile-name') !== false) {
			$field['defaultValue']['1.3'] = $_profileuser->first_name;
			$field['defaultValue']['1.6'] = $_profileuser->last_name;
			continue;
		}

		if (strpos($field['cssClass'], 'profile-display-name') !== false) {
			$_public_display = array ();
			$_public_display['display_nickname'] = $_profileuser->nickname;
			$_public_display['display_username'] = $_profileuser->user_login;

			if (! empty($_profileuser->first_name))
				$_public_display['display_firstname'] = $_profileuser->first_name;

			if (! empty($_profileuser->last_name))
				$_public_display['display_lastname'] = $_profileuser->last_name;

			if (! empty($_profileuser->first_name) && ! empty($_profileuser->last_name)) {
				$_public_display['display_firstlast'] = $_profileuser->first_name . ' ' . $_profileuser->last_name;
				$_public_display['display_lastfirst'] = $_profileuser->last_name . ' ' . $_profileuser->first_name;
			}

			if (! in_array($_profileuser->display_name, $_public_display)) // Only add this if it isn't duplicated elsewhere
				$_public_display = array ( 'display_displayname' => $_profileuser->display_name ) + $_public_display;

			$_public_display = array_map('trim', $_public_display);
			$_public_display = array_unique($_public_display);
			foreach ($_public_display as $id => $item) {
				$_is_selected = ($_profileuser->display_name == $item ? 1 : null);
				$choices[] = array ( 'text' => $item, 'value' => $item, 'isSelected' => $_is_selected );
			}
			$field['choices'] = $choices;
			continue;
		}

		foreach ($_gf_fields as $gf_key => $info) {
			if (strpos($field['cssClass'], 'profile-' . $gf_key) !== false) {
				$field['defaultValue'] = $_profileuser->$info['wp_meta'];
				break;
			}
		}
	}

	return $form;
}

Explanation of the above code

• We go through all the fields in the form and based on the class name we take some action.
• Each field is an array.
• The class names are stored in the element named “cssClass”
• We store the populated values in the elemend named “defaultValue”
• Lines 14 & 15: Gravity Forms defines the name as one field, but it keeps the First and Last name separate by means of the index .3 and .6. In order to populate the fields we need to create an array in the “defaultValue”. The index used is made up by the “Field ID” and the .3 or .6.
• Lines 40-44: The drop down values are not stored in the field “defaultValue” but they are stored in the field “choices”. This is associative array made up of “text”, “value” and “isSelected”. The latter one determines which of the values is selected by default.

Update after submission

/**
 * Update the user's profile with information from the received profile GF.
 * run last - just to make sure that everything is fine and dandy.
 *
 * @action gform_after_submission_
 */
function GF_update_profile ($entry, $form)
{
	global $wpdb;

	if (! is_user_logged_in()) {
		wp_redirect(home_url());
		exit();
	}

	$_user_id = get_current_user_id();
	$_user = new stdClass();
	$_user->ID = (int) $_user_id;
	$_userdata = get_userdata($_user_id);
	$_user->user_login = $wpdb->escape($_userdata->user_login);

	$gf_fields = GF_get_profile_fields();

	$_user->first_name = sanitize_text_field($entry[$gf_fields['first_name']['gf_index']]);
	$_user->last_name = sanitize_text_field($entry[$gf_fields['last_name']['gf_index']]);
	$_user->display_name = sanitize_text_field($entry[$gf_fields['display_name']['gf_index']]);

	$_user->user_url = esc_url_raw($entry[$gf_fields['website']['gf_index']]);
	$_user->user_url = preg_match('/^(https?):/is', $_user->user_url) ? $_user->user_url : 'http://' . $_user->user_url;

	wp_update_user(get_object_vars($_user));
}

Explanation of the above code

• After submission this function is called and all the new values are held in the array called “$entry”.
• I’m not 100% sure if Gravity Forms sanitizes all the fields correctly, so I decided to use the WordPress functions to sanitize the fields.
• Line 29 is actually not needed as Gravity Forms checks if the field start with HTTP before submitting the form.

Final Thoughts
And that’s it. I’m sure there are several improvements that can be made in the code and don’t hesitate to give idea’s on how to improve the code.
If you find yourself thinking you want this on your site and you need Gravity Forms, please follow my link to buy Gravity Forms.
If you aren’t a programmer and you want this implemented on your site you can contact me and we can see if we can work something out.