Completed
Push — develop ( 205b5c...cff5aa )
by
unknown
20:21
created
includes/extensions/edit-entry/class-edit-entry-user-registration.php 1 patch
Indentation   +262 added lines, -262 removed lines patch added patch discarded remove patch
@@ -11,7 +11,7 @@  discard block
 block discarded – undo
11 11
  */
12 12
 
13 13
 if ( ! defined( 'WPINC' ) ) {
14
-    die;
14
+	die;
15 15
 }
16 16
 
17 17
 /**
@@ -22,109 +22,109 @@  discard block
 block discarded – undo
22 22
 	/**
23 23
 	 * @var GravityView_Edit_Entry $loader
24 24
 	 */
25
-    protected $loader;
25
+	protected $loader;
26 26
 
27
-    /**
28
-     * @var WP_User|null Temporary storage used by restore_user_details()
29
-     */
30
-    private $_user_before_update = null;
27
+	/**
28
+	 * @var WP_User|null Temporary storage used by restore_user_details()
29
+	 */
30
+	private $_user_before_update = null;
31 31
 
32
-    function __construct( GravityView_Edit_Entry $loader ) {
33
-        $this->loader = $loader;
34
-    }
32
+	function __construct( GravityView_Edit_Entry $loader ) {
33
+		$this->loader = $loader;
34
+	}
35 35
 
36 36
 	/**
37 37
 	 * @since 1.11
38 38
 	 */
39 39
 	public function load() {
40 40
 		add_action( 'wp', array( $this, 'add_hooks' ), 10 );
41
-    }
41
+	}
42 42
 
43 43
 	/**
44 44
 	 * Add hooks to trigger updating the user
45 45
 	 *
46 46
 	 * @since 1.18
47 47
 	 */
48
-    public function add_hooks() {
49
-
50
-	    /**
51
-	     * @filter `gravityview/edit_entry/user_registration/trigger_update` Choose whether to update user information via User Registration add-on when an entry is updated?
52
-	     * @since 1.11
53
-	     * @param boolean $boolean Whether to trigger update on user registration (default: true)
54
-	     */
55
-	    if( apply_filters( 'gravityview/edit_entry/user_registration/trigger_update', true ) ) {
56
-
57
-	    	add_action( 'gravityview/edit_entry/after_update' , array( $this, 'update_user' ), 10, 2 );
58
-
59
-		    // last resort in case the current user display name don't match any of the defaults
60
-		    add_action( 'gform_user_updated', array( $this, 'restore_display_name' ), 10, 4 );
61
-	    }
62
-    }
63
-
64
-    /**
65
-     * Update the WordPress user profile based on the GF User Registration create feed
66
-     *
67
-     * @since 1.11
68
-     *
69
-     * @param array $form Gravity Forms form array
70
-     * @param string $entry_id Gravity Forms entry ID
71
-     * @return void
72
-     */
73
-    public function update_user( $form = array(), $entry_id = 0 ) {
74
-
75
-        if( ! class_exists( 'GFAPI' ) || ! class_exists( 'GF_User_Registration' ) ) {
76
-	        gravityview()->log->error( 'GFAPI or User Registration class not found; not updating the user' );
77
-	        return;
78
-        } elseif( empty( $entry_id ) ) {
79
-        	gravityview()->log->error( 'Entry ID is empty [{entry_id}]; not updating the user', array( 'entry_id' => $entry_id ) );
80
-	        return;
81
-        }
82
-
83
-        $gf_user_registration = GF_User_Registration::get_instance();
84
-
85
-        $entry = GFAPI::get_entry( $entry_id );
86
-
87
-	    /**
88
-	     * @filter `gravityview/edit_entry/user_registration/entry` Modify entry details before updating the user via User Registration add-on
89
-	     * @since 1.11
90
-	     * @param array $entry Gravity Forms entry
91
-	     * @param array $form Gravity Forms form
92
-	     */
93
-        $entry = apply_filters( 'gravityview/edit_entry/user_registration/entry', $entry, $form );
94
-
95
-	    $config = $this->get_feed_configuration( $entry, $form );
96
-
97
-        // Make sure the feed is active
98
-	    if ( ! \GV\Utils::get( $config, 'is_active', false ) ) {
48
+	public function add_hooks() {
49
+
50
+		/**
51
+		 * @filter `gravityview/edit_entry/user_registration/trigger_update` Choose whether to update user information via User Registration add-on when an entry is updated?
52
+		 * @since 1.11
53
+		 * @param boolean $boolean Whether to trigger update on user registration (default: true)
54
+		 */
55
+		if( apply_filters( 'gravityview/edit_entry/user_registration/trigger_update', true ) ) {
56
+
57
+			add_action( 'gravityview/edit_entry/after_update' , array( $this, 'update_user' ), 10, 2 );
58
+
59
+			// last resort in case the current user display name don't match any of the defaults
60
+			add_action( 'gform_user_updated', array( $this, 'restore_display_name' ), 10, 4 );
61
+		}
62
+	}
63
+
64
+	/**
65
+	 * Update the WordPress user profile based on the GF User Registration create feed
66
+	 *
67
+	 * @since 1.11
68
+	 *
69
+	 * @param array $form Gravity Forms form array
70
+	 * @param string $entry_id Gravity Forms entry ID
71
+	 * @return void
72
+	 */
73
+	public function update_user( $form = array(), $entry_id = 0 ) {
74
+
75
+		if( ! class_exists( 'GFAPI' ) || ! class_exists( 'GF_User_Registration' ) ) {
76
+			gravityview()->log->error( 'GFAPI or User Registration class not found; not updating the user' );
99 77
 			return;
100
-	    }
78
+		} elseif( empty( $entry_id ) ) {
79
+			gravityview()->log->error( 'Entry ID is empty [{entry_id}]; not updating the user', array( 'entry_id' => $entry_id ) );
80
+			return;
81
+		}
82
+
83
+		$gf_user_registration = GF_User_Registration::get_instance();
84
+
85
+		$entry = GFAPI::get_entry( $entry_id );
101 86
 
102
-	    // If an Update feed, make sure the conditions are met.
103
-	    if ( \GV\Utils::get( $config, 'meta/feedType' ) === 'update' ) {
104
-	    	if( ! $gf_user_registration->is_feed_condition_met( $config, $form, $entry ) ) {
105
-			    return;
106
-		    }
107
-	    }
87
+		/**
88
+		 * @filter `gravityview/edit_entry/user_registration/entry` Modify entry details before updating the user via User Registration add-on
89
+		 * @since 1.11
90
+		 * @param array $entry Gravity Forms entry
91
+		 * @param array $form Gravity Forms form
92
+		 */
93
+		$entry = apply_filters( 'gravityview/edit_entry/user_registration/entry', $entry, $form );
108 94
 
109
-	    // Do not update user if the user hasn't been registered (happens when manual activation is enabled in User Registration feed)
110
-	    $username = \GV\Utils::get( $config, 'meta/username', null );
111
-	    if ( ! isset( $entry[ $username ] ) || ! get_user_by( 'login', $entry[ $username ] ) ) {
112
-		    return;
113
-	    }
95
+		$config = $this->get_feed_configuration( $entry, $form );
96
+
97
+		// Make sure the feed is active
98
+		if ( ! \GV\Utils::get( $config, 'is_active', false ) ) {
99
+			return;
100
+		}
101
+
102
+		// If an Update feed, make sure the conditions are met.
103
+		if ( \GV\Utils::get( $config, 'meta/feedType' ) === 'update' ) {
104
+			if( ! $gf_user_registration->is_feed_condition_met( $config, $form, $entry ) ) {
105
+				return;
106
+			}
107
+		}
108
+
109
+		// Do not update user if the user hasn't been registered (happens when manual activation is enabled in User Registration feed)
110
+		$username = \GV\Utils::get( $config, 'meta/username', null );
111
+		if ( ! isset( $entry[ $username ] ) || ! get_user_by( 'login', $entry[ $username ] ) ) {
112
+			return;
113
+		}
114 114
 
115
-        // The priority is set to 3 so that default priority (10) will still override it
116
-        add_filter( 'send_password_change_email', '__return_false', 3 );
117
-        add_filter( 'send_email_change_email', '__return_false', 3 );
115
+		// The priority is set to 3 so that default priority (10) will still override it
116
+		add_filter( 'send_password_change_email', '__return_false', 3 );
117
+		add_filter( 'send_email_change_email', '__return_false', 3 );
118 118
 
119
-        // Trigger the User Registration update user method
120
-        $gf_user_registration->update_user( $entry, $form, $config );
119
+		// Trigger the User Registration update user method
120
+		$gf_user_registration->update_user( $entry, $form, $config );
121 121
 
122
-        remove_filter( 'send_password_change_email', '__return_false', 3 );
123
-        remove_filter( 'send_email_change_email', '__return_false', 3 );
122
+		remove_filter( 'send_password_change_email', '__return_false', 3 );
123
+		remove_filter( 'send_email_change_email', '__return_false', 3 );
124 124
 
125
-        // Prevent double-triggering by removing the hook
126
-	    remove_action( 'gravityview/edit_entry/after_update' , array( $this, 'update_user' ), 10 );
127
-    }
125
+		// Prevent double-triggering by removing the hook
126
+		remove_action( 'gravityview/edit_entry/after_update' , array( $this, 'update_user' ), 10 );
127
+	}
128 128
 
129 129
 	/**
130 130
 	 * Get the User Registration feed configuration for the entry & form
@@ -139,184 +139,184 @@  discard block
 block discarded – undo
139 139
 	 *
140 140
 	 * @return array
141 141
 	 */
142
-    public function get_feed_configuration( $entry, $form ) {
143
-
144
-	    $gf_user_registration = GF_User_Registration::get_instance();
145
-
146
-	    $config = $gf_user_registration->get_single_submission_feed( $entry, $form );
147
-
148
-	    /**
149
-	     * @filter `gravityview/edit_entry/user_registration/preserve_role` Keep the current user role or override with the role defined in the Create feed
150
-	     * @since 1.15
151
-	     * @param[in,out] boolean $preserve_role Preserve current user role Default: true
152
-	     * @param[in] array $config Gravity Forms User Registration feed configuration for the form
153
-	     * @param[in] array $form Gravity Forms form array
154
-	     * @param[in] array $entry Gravity Forms entry being edited
155
-	     */
156
-	    $preserve_role = apply_filters( 'gravityview/edit_entry/user_registration/preserve_role', true, $config, $form, $entry );
157
-
158
-	    if( $preserve_role ) {
159
-		    $config['meta']['role'] = 'gfur_preserve_role';
160
-	    }
161
-
162
-	    $displayname = $this->match_current_display_name( $entry['created_by'] );
163
-
164
-	    /**
165
-	     * Make sure the current display name is not changed with the update user method.
166
-	     * @since 1.15
167
-	     */
168
-	    $config['meta']['displayname'] = $displayname ? $displayname : $config['meta']['displayname'];
169
-
170
-	    /**
171
-	     * @filter `gravityview/edit_entry/user_registration/config` Modify the User Registration Addon feed configuration
172
-	     * @since 1.14
173
-	     * @param[in,out] array $config Gravity Forms User Registration feed configuration for the form
174
-	     * @param[in] array $form Gravity Forms form array
175
-	     * @param[in] array $entry Gravity Forms entry being edited
176
-	     */
177
-	    $config = apply_filters( 'gravityview/edit_entry/user_registration/config', $config, $form, $entry );
178
-
179
-	    return $config;
180
-    }
181
-
182
-    /**
183
-     * Calculate the user display name format
184
-     *
185
-     * @since 1.15
186
-     * @since 1.20 Returns false if user not found at $user_id
187
-     *
188
-     * @param int $user_id WP User ID
189
-     * @return false|string Display name format as used inside Gravity Forms User Registration. Returns false if user not found.
190
-     */
191
-    public function match_current_display_name( $user_id ) {
192
-
193
-        $user = get_userdata( $user_id );
194
-
195
-        if( ! $user ) {
196
-        	return false;
197
-        }
198
-
199
-        $names = $this->generate_display_names( $user );
200
-
201
-        $format = array_search( $user->display_name, $names, true );
202
-
203
-        /**
204
-         * In case we can't find the current display name format, trigger last resort method at the 'gform_user_updated' hook
205
-         * @see restore_display_name
206
-         */
207
-        if( false === $format ) {
208
-            $this->_user_before_update = $user;
209
-        }
210
-
211
-        return $format;
212
-    }
213
-
214
-    /**
215
-     * Generate an array of all the user display names possibilities
216
-     *
217
-     * @since 1.15
218
-     *
219
-     * @param object $profileuser WP_User object
220
-     * @return array List all the possible display names for a certain User object
221
-     */
222
-    public function generate_display_names( $profileuser ) {
223
-
224
-        $public_display = array();
225
-        $public_display['nickname']  = $profileuser->nickname;
226
-        $public_display['username']  = $profileuser->user_login;
227
-
228
-        if ( !empty($profileuser->first_name) ) {
229
-	        $public_display['firstname'] = $profileuser->first_name;
230
-        }
231
-
232
-        if ( !empty($profileuser->last_name) ) {
233
-	        $public_display['lastname'] = $profileuser->last_name;
234
-        }
235
-
236
-        if ( !empty($profileuser->first_name) && !empty($profileuser->last_name) ) {
237
-            $public_display['firstlast'] = $profileuser->first_name . ' ' . $profileuser->last_name;
238
-            $public_display['lastfirst'] = $profileuser->last_name . ' ' . $profileuser->first_name;
239
-        }
240
-
241
-        $public_display = array_map( 'trim', $public_display );
242
-        $public_display = array_unique( $public_display );
243
-
244
-        return $public_display;
245
-    }
246
-
247
-
248
-    /**
249
-     * Restore the Display Name and roles of a user after being updated by Gravity Forms User Registration Addon
250
-     *
251
-     * @see GFUser::update_user()
252
-     * @param int $user_id WP User ID that was updated by Gravity Forms User Registration Addon
253
-     * @param array $config Gravity Forms User Registration Addon form feed configuration
254
-     * @param array $entry The Gravity Forms entry that was just updated
255
-     * @param string $password User password
256
-     * @return int|false|WP_Error|null True: User updated; False: $user_id not a valid User ID; WP_Error: User update error; Null: Method didn't process
257
-     */
258
-    public function restore_display_name( $user_id = 0, $config = array(), $entry = array(), $password = '' ) {
259
-
260
-        /**
261
-         * @filter `gravityview/edit_entry/restore_display_name` Whether display names should be restored to before updating an entry.
262
-         * Otherwise, display names will be reset to the format specified in Gravity Forms User Registration "Update" feed
263
-         * @since 1.14.4
264
-         * @param boolean $restore_display_name Restore Display Name? Default: true
265
-         */
266
-        $restore_display_name = apply_filters( 'gravityview/edit_entry/restore_display_name', true );
267
-
268
-        $is_update_feed = ( $config && \GV\Utils::get( $config, 'meta/feed_type' ) === 'update' );
269
-
270
-        /**
271
-         * Don't restore display name:
272
-         *   - either disabled,
273
-         *   - or it is an Update feed (we only care about Create feed)
274
-         *   - or we don't need as we found the correct format before updating user.
275
-         * @since 1.14.4
276
-         */
277
-        if( ! $restore_display_name || $is_update_feed || is_null( $this->_user_before_update ) ) {
278
-            return null;
279
-        }
280
-
281
-        $user_after_update = get_userdata( $user_id );
282
-
283
-        // User not found
284
-	    if ( ! $user_after_update ) {
285
-	    	gravityview()->log->error( 'User not found at $user_id #{user_id}', array( 'user_id' => $user_id ) );
286
-		    return false;
287
-	    }
288
-
289
-        $restored_user = $user_after_update;
290
-
291
-	    // Restore previous display_name
292
-        $restored_user->display_name = $this->_user_before_update->display_name;
293
-
294
-	    // Don't have WP update the password.
295
-	    unset( $restored_user->data->user_pass, $restored_user->user_pass );
296
-
297
-        /**
298
-         * Modify the user data after updated by Gravity Forms User Registration but before restored by GravityView
299
-         * @since 1.14
300
-         * @param WP_User $restored_user The user with restored details about to be updated by wp_update_user()
301
-         * @param WP_User $user_before_update The user before being updated by Gravity Forms User Registration
302
-         * @param WP_User $user_after_update The user after being updated by Gravity Forms User Registration
303
-         * @param array   $entry The Gravity Forms entry that was just updated
304
-         */
305
-        $restored_user = apply_filters( 'gravityview/edit_entry/user_registration/restored_user', $restored_user, $this->_user_before_update, $user_after_update, $entry );
306
-
307
-        $updated = wp_update_user( $restored_user );
308
-
309
-        if( is_wp_error( $updated ) ) {
310
-            gravityview()->log->error( 'There was an error updating user #{user_id} details', array( 'user_id' => $user_id, 'data' => $updated ) );
311
-        } else {
312
-            gravityview()->log->debug( 'User #{user_id} details restored', array( 'user_id' => $user_id ) );
313
-        }
314
-
315
-        $this->_user_before_update = null;
316
-
317
-        unset( $restored_user, $user_after_update );
318
-
319
-        return $updated;
320
-    }
142
+	public function get_feed_configuration( $entry, $form ) {
143
+
144
+		$gf_user_registration = GF_User_Registration::get_instance();
145
+
146
+		$config = $gf_user_registration->get_single_submission_feed( $entry, $form );
147
+
148
+		/**
149
+		 * @filter `gravityview/edit_entry/user_registration/preserve_role` Keep the current user role or override with the role defined in the Create feed
150
+		 * @since 1.15
151
+		 * @param[in,out] boolean $preserve_role Preserve current user role Default: true
152
+		 * @param[in] array $config Gravity Forms User Registration feed configuration for the form
153
+		 * @param[in] array $form Gravity Forms form array
154
+		 * @param[in] array $entry Gravity Forms entry being edited
155
+		 */
156
+		$preserve_role = apply_filters( 'gravityview/edit_entry/user_registration/preserve_role', true, $config, $form, $entry );
157
+
158
+		if( $preserve_role ) {
159
+			$config['meta']['role'] = 'gfur_preserve_role';
160
+		}
161
+
162
+		$displayname = $this->match_current_display_name( $entry['created_by'] );
163
+
164
+		/**
165
+		 * Make sure the current display name is not changed with the update user method.
166
+		 * @since 1.15
167
+		 */
168
+		$config['meta']['displayname'] = $displayname ? $displayname : $config['meta']['displayname'];
169
+
170
+		/**
171
+		 * @filter `gravityview/edit_entry/user_registration/config` Modify the User Registration Addon feed configuration
172
+		 * @since 1.14
173
+		 * @param[in,out] array $config Gravity Forms User Registration feed configuration for the form
174
+		 * @param[in] array $form Gravity Forms form array
175
+		 * @param[in] array $entry Gravity Forms entry being edited
176
+		 */
177
+		$config = apply_filters( 'gravityview/edit_entry/user_registration/config', $config, $form, $entry );
178
+
179
+		return $config;
180
+	}
181
+
182
+	/**
183
+	 * Calculate the user display name format
184
+	 *
185
+	 * @since 1.15
186
+	 * @since 1.20 Returns false if user not found at $user_id
187
+	 *
188
+	 * @param int $user_id WP User ID
189
+	 * @return false|string Display name format as used inside Gravity Forms User Registration. Returns false if user not found.
190
+	 */
191
+	public function match_current_display_name( $user_id ) {
192
+
193
+		$user = get_userdata( $user_id );
194
+
195
+		if( ! $user ) {
196
+			return false;
197
+		}
198
+
199
+		$names = $this->generate_display_names( $user );
200
+
201
+		$format = array_search( $user->display_name, $names, true );
202
+
203
+		/**
204
+		 * In case we can't find the current display name format, trigger last resort method at the 'gform_user_updated' hook
205
+		 * @see restore_display_name
206
+		 */
207
+		if( false === $format ) {
208
+			$this->_user_before_update = $user;
209
+		}
210
+
211
+		return $format;
212
+	}
213
+
214
+	/**
215
+	 * Generate an array of all the user display names possibilities
216
+	 *
217
+	 * @since 1.15
218
+	 *
219
+	 * @param object $profileuser WP_User object
220
+	 * @return array List all the possible display names for a certain User object
221
+	 */
222
+	public function generate_display_names( $profileuser ) {
223
+
224
+		$public_display = array();
225
+		$public_display['nickname']  = $profileuser->nickname;
226
+		$public_display['username']  = $profileuser->user_login;
227
+
228
+		if ( !empty($profileuser->first_name) ) {
229
+			$public_display['firstname'] = $profileuser->first_name;
230
+		}
231
+
232
+		if ( !empty($profileuser->last_name) ) {
233
+			$public_display['lastname'] = $profileuser->last_name;
234
+		}
235
+
236
+		if ( !empty($profileuser->first_name) && !empty($profileuser->last_name) ) {
237
+			$public_display['firstlast'] = $profileuser->first_name . ' ' . $profileuser->last_name;
238
+			$public_display['lastfirst'] = $profileuser->last_name . ' ' . $profileuser->first_name;
239
+		}
240
+
241
+		$public_display = array_map( 'trim', $public_display );
242
+		$public_display = array_unique( $public_display );
243
+
244
+		return $public_display;
245
+	}
246
+
247
+
248
+	/**
249
+	 * Restore the Display Name and roles of a user after being updated by Gravity Forms User Registration Addon
250
+	 *
251
+	 * @see GFUser::update_user()
252
+	 * @param int $user_id WP User ID that was updated by Gravity Forms User Registration Addon
253
+	 * @param array $config Gravity Forms User Registration Addon form feed configuration
254
+	 * @param array $entry The Gravity Forms entry that was just updated
255
+	 * @param string $password User password
256
+	 * @return int|false|WP_Error|null True: User updated; False: $user_id not a valid User ID; WP_Error: User update error; Null: Method didn't process
257
+	 */
258
+	public function restore_display_name( $user_id = 0, $config = array(), $entry = array(), $password = '' ) {
259
+
260
+		/**
261
+		 * @filter `gravityview/edit_entry/restore_display_name` Whether display names should be restored to before updating an entry.
262
+		 * Otherwise, display names will be reset to the format specified in Gravity Forms User Registration "Update" feed
263
+		 * @since 1.14.4
264
+		 * @param boolean $restore_display_name Restore Display Name? Default: true
265
+		 */
266
+		$restore_display_name = apply_filters( 'gravityview/edit_entry/restore_display_name', true );
267
+
268
+		$is_update_feed = ( $config && \GV\Utils::get( $config, 'meta/feed_type' ) === 'update' );
269
+
270
+		/**
271
+		 * Don't restore display name:
272
+		 *   - either disabled,
273
+		 *   - or it is an Update feed (we only care about Create feed)
274
+		 *   - or we don't need as we found the correct format before updating user.
275
+		 * @since 1.14.4
276
+		 */
277
+		if( ! $restore_display_name || $is_update_feed || is_null( $this->_user_before_update ) ) {
278
+			return null;
279
+		}
280
+
281
+		$user_after_update = get_userdata( $user_id );
282
+
283
+		// User not found
284
+		if ( ! $user_after_update ) {
285
+			gravityview()->log->error( 'User not found at $user_id #{user_id}', array( 'user_id' => $user_id ) );
286
+			return false;
287
+		}
288
+
289
+		$restored_user = $user_after_update;
290
+
291
+		// Restore previous display_name
292
+		$restored_user->display_name = $this->_user_before_update->display_name;
293
+
294
+		// Don't have WP update the password.
295
+		unset( $restored_user->data->user_pass, $restored_user->user_pass );
296
+
297
+		/**
298
+		 * Modify the user data after updated by Gravity Forms User Registration but before restored by GravityView
299
+		 * @since 1.14
300
+		 * @param WP_User $restored_user The user with restored details about to be updated by wp_update_user()
301
+		 * @param WP_User $user_before_update The user before being updated by Gravity Forms User Registration
302
+		 * @param WP_User $user_after_update The user after being updated by Gravity Forms User Registration
303
+		 * @param array   $entry The Gravity Forms entry that was just updated
304
+		 */
305
+		$restored_user = apply_filters( 'gravityview/edit_entry/user_registration/restored_user', $restored_user, $this->_user_before_update, $user_after_update, $entry );
306
+
307
+		$updated = wp_update_user( $restored_user );
308
+
309
+		if( is_wp_error( $updated ) ) {
310
+			gravityview()->log->error( 'There was an error updating user #{user_id} details', array( 'user_id' => $user_id, 'data' => $updated ) );
311
+		} else {
312
+			gravityview()->log->debug( 'User #{user_id} details restored', array( 'user_id' => $user_id ) );
313
+		}
314
+
315
+		$this->_user_before_update = null;
316
+
317
+		unset( $restored_user, $user_after_update );
318
+
319
+		return $updated;
320
+	}
321 321
 
322 322
 } //end class
Please login to merge, or discard this patch.