@@ -11,7 +11,7 @@ discard block |
||
11 | 11 | */ |
12 | 12 | |
13 | 13 | if ( ! defined( 'WPINC' ) ) { |
14 | - die; |
|
14 | + die; |
|
15 | 15 | } |
16 | 16 | |
17 | 17 | /** |
@@ -22,104 +22,104 @@ discard block |
||
22 | 22 | /** |
23 | 23 | * @var GravityView_Edit_Entry |
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 | - /** @var GF_User_Registration $gf_user_registration */ |
|
84 | - $gf_user_registration = GF_User_Registration::get_instance(); |
|
85 | - |
|
86 | - $entry = GFAPI::get_entry( $entry_id ); |
|
87 | - |
|
88 | - /** |
|
89 | - * @filter `gravityview/edit_entry/user_registration/entry` Modify entry details before updating the user via User Registration add-on |
|
90 | - * @since 1.11 |
|
91 | - * @param array $entry Gravity Forms entry |
|
92 | - * @param array $form Gravity Forms form |
|
93 | - */ |
|
94 | - $entry = apply_filters( 'gravityview/edit_entry/user_registration/entry', $entry, $form ); |
|
95 | - |
|
96 | - $config = $this->get_feed_configuration( $entry, $form ); |
|
97 | - |
|
98 | - // Make sure the feed is active |
|
99 | - 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' ); |
|
100 | 77 | return; |
101 | - } |
|
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 | + /** @var GF_User_Registration $gf_user_registration */ |
|
84 | + $gf_user_registration = GF_User_Registration::get_instance(); |
|
85 | + |
|
86 | + $entry = GFAPI::get_entry( $entry_id ); |
|
102 | 87 | |
103 | - // If an Update feed, make sure the conditions are met. |
|
104 | - if ( \GV\Utils::get( $config, 'meta/feedType' ) === 'update' ) { |
|
105 | - if( ! $gf_user_registration->is_feed_condition_met( $config, $form, $entry ) ) { |
|
106 | - return; |
|
107 | - } |
|
108 | - } |
|
88 | + /** |
|
89 | + * @filter `gravityview/edit_entry/user_registration/entry` Modify entry details before updating the user via User Registration add-on |
|
90 | + * @since 1.11 |
|
91 | + * @param array $entry Gravity Forms entry |
|
92 | + * @param array $form Gravity Forms form |
|
93 | + */ |
|
94 | + $entry = apply_filters( 'gravityview/edit_entry/user_registration/entry', $entry, $form ); |
|
95 | + |
|
96 | + $config = $this->get_feed_configuration( $entry, $form ); |
|
97 | + |
|
98 | + // Make sure the feed is active |
|
99 | + if ( ! \GV\Utils::get( $config, 'is_active', false ) ) { |
|
100 | + return; |
|
101 | + } |
|
109 | 102 | |
110 | - // The priority is set to 3 so that default priority (10) will still override it |
|
111 | - add_filter( 'send_password_change_email', '__return_false', 3 ); |
|
112 | - add_filter( 'send_email_change_email', '__return_false', 3 ); |
|
103 | + // If an Update feed, make sure the conditions are met. |
|
104 | + if ( \GV\Utils::get( $config, 'meta/feedType' ) === 'update' ) { |
|
105 | + if( ! $gf_user_registration->is_feed_condition_met( $config, $form, $entry ) ) { |
|
106 | + return; |
|
107 | + } |
|
108 | + } |
|
113 | 109 | |
114 | - // Trigger the User Registration update user method |
|
115 | - $gf_user_registration->update_user( $entry, $form, $config ); |
|
110 | + // The priority is set to 3 so that default priority (10) will still override it |
|
111 | + add_filter( 'send_password_change_email', '__return_false', 3 ); |
|
112 | + add_filter( 'send_email_change_email', '__return_false', 3 ); |
|
116 | 113 | |
117 | - remove_filter( 'send_password_change_email', '__return_false', 3 ); |
|
118 | - remove_filter( 'send_email_change_email', '__return_false', 3 ); |
|
114 | + // Trigger the User Registration update user method |
|
115 | + $gf_user_registration->update_user( $entry, $form, $config ); |
|
119 | 116 | |
120 | - // Prevent double-triggering by removing the hook |
|
121 | - remove_action( 'gravityview/edit_entry/after_update' , array( $this, 'update_user' ), 10 ); |
|
122 | - } |
|
117 | + remove_filter( 'send_password_change_email', '__return_false', 3 ); |
|
118 | + remove_filter( 'send_email_change_email', '__return_false', 3 ); |
|
119 | + |
|
120 | + // Prevent double-triggering by removing the hook |
|
121 | + remove_action( 'gravityview/edit_entry/after_update' , array( $this, 'update_user' ), 10 ); |
|
122 | + } |
|
123 | 123 | |
124 | 124 | /** |
125 | 125 | * Get the User Registration feed configuration for the entry & form |
@@ -134,185 +134,185 @@ discard block |
||
134 | 134 | * |
135 | 135 | * @return array |
136 | 136 | */ |
137 | - public function get_feed_configuration( $entry, $form ) { |
|
138 | - |
|
139 | - /** @var GF_User_Registration $gf_user_registration */ |
|
140 | - $gf_user_registration = GF_User_Registration::get_instance(); |
|
141 | - |
|
142 | - $config = $gf_user_registration->get_single_submission_feed( $entry, $form ); |
|
143 | - |
|
144 | - /** |
|
145 | - * @filter `gravityview/edit_entry/user_registration/preserve_role` Keep the current user role or override with the role defined in the Create feed |
|
146 | - * @since 1.15 |
|
147 | - * @param[in,out] boolean $preserve_role Preserve current user role Default: true |
|
148 | - * @param[in] array $config Gravity Forms User Registration feed configuration for the form |
|
149 | - * @param[in] array $form Gravity Forms form array |
|
150 | - * @param[in] array $entry Gravity Forms entry being edited |
|
151 | - */ |
|
152 | - $preserve_role = apply_filters( 'gravityview/edit_entry/user_registration/preserve_role', true, $config, $form, $entry ); |
|
153 | - |
|
154 | - if( $preserve_role ) { |
|
155 | - $config['meta']['role'] = 'gfur_preserve_role'; |
|
156 | - } |
|
157 | - |
|
158 | - $displayname = $this->match_current_display_name( $entry['created_by'] ); |
|
159 | - |
|
160 | - /** |
|
161 | - * Make sure the current display name is not changed with the update user method. |
|
162 | - * @since 1.15 |
|
163 | - */ |
|
164 | - $config['meta']['displayname'] = $displayname ? $displayname : $config['meta']['displayname']; |
|
165 | - |
|
166 | - /** |
|
167 | - * @filter `gravityview/edit_entry/user_registration/config` Modify the User Registration Addon feed configuration |
|
168 | - * @since 1.14 |
|
169 | - * @param[in,out] array $config Gravity Forms User Registration feed configuration for the form |
|
170 | - * @param[in] array $form Gravity Forms form array |
|
171 | - * @param[in] array $entry Gravity Forms entry being edited |
|
172 | - */ |
|
173 | - $config = apply_filters( 'gravityview/edit_entry/user_registration/config', $config, $form, $entry ); |
|
174 | - |
|
175 | - return $config; |
|
176 | - } |
|
177 | - |
|
178 | - /** |
|
179 | - * Calculate the user display name format |
|
180 | - * |
|
181 | - * @since 1.15 |
|
182 | - * @since 1.20 Returns false if user not found at $user_id |
|
183 | - * |
|
184 | - * @param int $user_id WP User ID |
|
185 | - * @return false|string Display name format as used inside Gravity Forms User Registration. Returns false if user not found. |
|
186 | - */ |
|
187 | - public function match_current_display_name( $user_id ) { |
|
188 | - |
|
189 | - $user = get_userdata( $user_id ); |
|
190 | - |
|
191 | - if( ! $user ) { |
|
192 | - return false; |
|
193 | - } |
|
194 | - |
|
195 | - $names = $this->generate_display_names( $user ); |
|
196 | - |
|
197 | - $format = array_search( $user->display_name, $names, true ); |
|
198 | - |
|
199 | - /** |
|
200 | - * In case we can't find the current display name format, trigger last resort method at the 'gform_user_updated' hook |
|
201 | - * @see restore_display_name |
|
202 | - */ |
|
203 | - if( false === $format ) { |
|
204 | - $this->_user_before_update = $user; |
|
205 | - } |
|
206 | - |
|
207 | - return $format; |
|
208 | - } |
|
209 | - |
|
210 | - /** |
|
211 | - * Generate an array of all the user display names possibilities |
|
212 | - * |
|
213 | - * @since 1.15 |
|
214 | - * |
|
215 | - * @param object $profileuser WP_User object |
|
216 | - * @return array List all the possible display names for a certain User object |
|
217 | - */ |
|
218 | - public function generate_display_names( $profileuser ) { |
|
219 | - |
|
220 | - $public_display = array(); |
|
221 | - $public_display['nickname'] = $profileuser->nickname; |
|
222 | - $public_display['username'] = $profileuser->user_login; |
|
223 | - |
|
224 | - if ( !empty($profileuser->first_name) ) { |
|
225 | - $public_display['firstname'] = $profileuser->first_name; |
|
226 | - } |
|
227 | - |
|
228 | - if ( !empty($profileuser->last_name) ) { |
|
229 | - $public_display['lastname'] = $profileuser->last_name; |
|
230 | - } |
|
231 | - |
|
232 | - if ( !empty($profileuser->first_name) && !empty($profileuser->last_name) ) { |
|
233 | - $public_display['firstlast'] = $profileuser->first_name . ' ' . $profileuser->last_name; |
|
234 | - $public_display['lastfirst'] = $profileuser->last_name . ' ' . $profileuser->first_name; |
|
235 | - } |
|
236 | - |
|
237 | - $public_display = array_map( 'trim', $public_display ); |
|
238 | - $public_display = array_unique( $public_display ); |
|
239 | - |
|
240 | - return $public_display; |
|
241 | - } |
|
242 | - |
|
243 | - |
|
244 | - /** |
|
245 | - * Restore the Display Name and roles of a user after being updated by Gravity Forms User Registration Addon |
|
246 | - * |
|
247 | - * @see GFUser::update_user() |
|
248 | - * @param int $user_id WP User ID that was updated by Gravity Forms User Registration Addon |
|
249 | - * @param array $config Gravity Forms User Registration Addon form feed configuration |
|
250 | - * @param array $entry The Gravity Forms entry that was just updated |
|
251 | - * @param string $password User password |
|
252 | - * @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 |
|
253 | - */ |
|
254 | - public function restore_display_name( $user_id = 0, $config = array(), $entry = array(), $password = '' ) { |
|
255 | - |
|
256 | - /** |
|
257 | - * @filter `gravityview/edit_entry/restore_display_name` Whether display names should be restored to before updating an entry. |
|
258 | - * Otherwise, display names will be reset to the format specified in Gravity Forms User Registration "Update" feed |
|
259 | - * @since 1.14.4 |
|
260 | - * @param boolean $restore_display_name Restore Display Name? Default: true |
|
261 | - */ |
|
262 | - $restore_display_name = apply_filters( 'gravityview/edit_entry/restore_display_name', true ); |
|
263 | - |
|
264 | - $is_update_feed = ( $config && \GV\Utils::get( $config, 'meta/feed_type' ) === 'update' ); |
|
265 | - |
|
266 | - /** |
|
267 | - * Don't restore display name: |
|
268 | - * - either disabled, |
|
269 | - * - or it is an Update feed (we only care about Create feed) |
|
270 | - * - or we don't need as we found the correct format before updating user. |
|
271 | - * @since 1.14.4 |
|
272 | - */ |
|
273 | - if( ! $restore_display_name || $is_update_feed || is_null( $this->_user_before_update ) ) { |
|
274 | - return null; |
|
275 | - } |
|
276 | - |
|
277 | - $user_after_update = get_userdata( $user_id ); |
|
278 | - |
|
279 | - // User not found |
|
280 | - if ( ! $user_after_update ) { |
|
281 | - gravityview()->log->error( 'User not found at $user_id #{user_id}', array( 'user_id' => $user_id ) ); |
|
282 | - return false; |
|
283 | - } |
|
284 | - |
|
285 | - $restored_user = $user_after_update; |
|
286 | - |
|
287 | - // Restore previous display_name |
|
288 | - $restored_user->display_name = $this->_user_before_update->display_name; |
|
289 | - |
|
290 | - // Don't have WP update the password. |
|
291 | - unset( $restored_user->data->user_pass, $restored_user->user_pass ); |
|
292 | - |
|
293 | - /** |
|
294 | - * Modify the user data after updated by Gravity Forms User Registration but before restored by GravityView |
|
295 | - * @since 1.14 |
|
296 | - * @param WP_User $restored_user The user with restored details about to be updated by wp_update_user() |
|
297 | - * @param WP_User $user_before_update The user before being updated by Gravity Forms User Registration |
|
298 | - * @param WP_User $user_after_update The user after being updated by Gravity Forms User Registration |
|
299 | - * @param array $entry The Gravity Forms entry that was just updated |
|
300 | - */ |
|
301 | - $restored_user = apply_filters( 'gravityview/edit_entry/user_registration/restored_user', $restored_user, $this->_user_before_update, $user_after_update, $entry ); |
|
302 | - |
|
303 | - $updated = wp_update_user( $restored_user ); |
|
304 | - |
|
305 | - if( is_wp_error( $updated ) ) { |
|
306 | - gravityview()->log->error( 'There was an error updating user #{user_id} details', array( 'user_id' => $user_id, 'data' => $updated ) ); |
|
307 | - } else { |
|
308 | - gravityview()->log->debug( 'User #{user_id} details restored', array( 'user_id' => $user_id ) ); |
|
309 | - } |
|
310 | - |
|
311 | - $this->_user_before_update = null; |
|
312 | - |
|
313 | - unset( $restored_user, $user_after_update ); |
|
314 | - |
|
315 | - return $updated; |
|
316 | - } |
|
137 | + public function get_feed_configuration( $entry, $form ) { |
|
138 | + |
|
139 | + /** @var GF_User_Registration $gf_user_registration */ |
|
140 | + $gf_user_registration = GF_User_Registration::get_instance(); |
|
141 | + |
|
142 | + $config = $gf_user_registration->get_single_submission_feed( $entry, $form ); |
|
143 | + |
|
144 | + /** |
|
145 | + * @filter `gravityview/edit_entry/user_registration/preserve_role` Keep the current user role or override with the role defined in the Create feed |
|
146 | + * @since 1.15 |
|
147 | + * @param[in,out] boolean $preserve_role Preserve current user role Default: true |
|
148 | + * @param[in] array $config Gravity Forms User Registration feed configuration for the form |
|
149 | + * @param[in] array $form Gravity Forms form array |
|
150 | + * @param[in] array $entry Gravity Forms entry being edited |
|
151 | + */ |
|
152 | + $preserve_role = apply_filters( 'gravityview/edit_entry/user_registration/preserve_role', true, $config, $form, $entry ); |
|
153 | + |
|
154 | + if( $preserve_role ) { |
|
155 | + $config['meta']['role'] = 'gfur_preserve_role'; |
|
156 | + } |
|
157 | + |
|
158 | + $displayname = $this->match_current_display_name( $entry['created_by'] ); |
|
159 | + |
|
160 | + /** |
|
161 | + * Make sure the current display name is not changed with the update user method. |
|
162 | + * @since 1.15 |
|
163 | + */ |
|
164 | + $config['meta']['displayname'] = $displayname ? $displayname : $config['meta']['displayname']; |
|
165 | + |
|
166 | + /** |
|
167 | + * @filter `gravityview/edit_entry/user_registration/config` Modify the User Registration Addon feed configuration |
|
168 | + * @since 1.14 |
|
169 | + * @param[in,out] array $config Gravity Forms User Registration feed configuration for the form |
|
170 | + * @param[in] array $form Gravity Forms form array |
|
171 | + * @param[in] array $entry Gravity Forms entry being edited |
|
172 | + */ |
|
173 | + $config = apply_filters( 'gravityview/edit_entry/user_registration/config', $config, $form, $entry ); |
|
174 | + |
|
175 | + return $config; |
|
176 | + } |
|
177 | + |
|
178 | + /** |
|
179 | + * Calculate the user display name format |
|
180 | + * |
|
181 | + * @since 1.15 |
|
182 | + * @since 1.20 Returns false if user not found at $user_id |
|
183 | + * |
|
184 | + * @param int $user_id WP User ID |
|
185 | + * @return false|string Display name format as used inside Gravity Forms User Registration. Returns false if user not found. |
|
186 | + */ |
|
187 | + public function match_current_display_name( $user_id ) { |
|
188 | + |
|
189 | + $user = get_userdata( $user_id ); |
|
190 | + |
|
191 | + if( ! $user ) { |
|
192 | + return false; |
|
193 | + } |
|
194 | + |
|
195 | + $names = $this->generate_display_names( $user ); |
|
196 | + |
|
197 | + $format = array_search( $user->display_name, $names, true ); |
|
198 | + |
|
199 | + /** |
|
200 | + * In case we can't find the current display name format, trigger last resort method at the 'gform_user_updated' hook |
|
201 | + * @see restore_display_name |
|
202 | + */ |
|
203 | + if( false === $format ) { |
|
204 | + $this->_user_before_update = $user; |
|
205 | + } |
|
206 | + |
|
207 | + return $format; |
|
208 | + } |
|
209 | + |
|
210 | + /** |
|
211 | + * Generate an array of all the user display names possibilities |
|
212 | + * |
|
213 | + * @since 1.15 |
|
214 | + * |
|
215 | + * @param object $profileuser WP_User object |
|
216 | + * @return array List all the possible display names for a certain User object |
|
217 | + */ |
|
218 | + public function generate_display_names( $profileuser ) { |
|
219 | + |
|
220 | + $public_display = array(); |
|
221 | + $public_display['nickname'] = $profileuser->nickname; |
|
222 | + $public_display['username'] = $profileuser->user_login; |
|
223 | + |
|
224 | + if ( !empty($profileuser->first_name) ) { |
|
225 | + $public_display['firstname'] = $profileuser->first_name; |
|
226 | + } |
|
227 | + |
|
228 | + if ( !empty($profileuser->last_name) ) { |
|
229 | + $public_display['lastname'] = $profileuser->last_name; |
|
230 | + } |
|
231 | + |
|
232 | + if ( !empty($profileuser->first_name) && !empty($profileuser->last_name) ) { |
|
233 | + $public_display['firstlast'] = $profileuser->first_name . ' ' . $profileuser->last_name; |
|
234 | + $public_display['lastfirst'] = $profileuser->last_name . ' ' . $profileuser->first_name; |
|
235 | + } |
|
236 | + |
|
237 | + $public_display = array_map( 'trim', $public_display ); |
|
238 | + $public_display = array_unique( $public_display ); |
|
239 | + |
|
240 | + return $public_display; |
|
241 | + } |
|
242 | + |
|
243 | + |
|
244 | + /** |
|
245 | + * Restore the Display Name and roles of a user after being updated by Gravity Forms User Registration Addon |
|
246 | + * |
|
247 | + * @see GFUser::update_user() |
|
248 | + * @param int $user_id WP User ID that was updated by Gravity Forms User Registration Addon |
|
249 | + * @param array $config Gravity Forms User Registration Addon form feed configuration |
|
250 | + * @param array $entry The Gravity Forms entry that was just updated |
|
251 | + * @param string $password User password |
|
252 | + * @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 |
|
253 | + */ |
|
254 | + public function restore_display_name( $user_id = 0, $config = array(), $entry = array(), $password = '' ) { |
|
255 | + |
|
256 | + /** |
|
257 | + * @filter `gravityview/edit_entry/restore_display_name` Whether display names should be restored to before updating an entry. |
|
258 | + * Otherwise, display names will be reset to the format specified in Gravity Forms User Registration "Update" feed |
|
259 | + * @since 1.14.4 |
|
260 | + * @param boolean $restore_display_name Restore Display Name? Default: true |
|
261 | + */ |
|
262 | + $restore_display_name = apply_filters( 'gravityview/edit_entry/restore_display_name', true ); |
|
263 | + |
|
264 | + $is_update_feed = ( $config && \GV\Utils::get( $config, 'meta/feed_type' ) === 'update' ); |
|
265 | + |
|
266 | + /** |
|
267 | + * Don't restore display name: |
|
268 | + * - either disabled, |
|
269 | + * - or it is an Update feed (we only care about Create feed) |
|
270 | + * - or we don't need as we found the correct format before updating user. |
|
271 | + * @since 1.14.4 |
|
272 | + */ |
|
273 | + if( ! $restore_display_name || $is_update_feed || is_null( $this->_user_before_update ) ) { |
|
274 | + return null; |
|
275 | + } |
|
276 | + |
|
277 | + $user_after_update = get_userdata( $user_id ); |
|
278 | + |
|
279 | + // User not found |
|
280 | + if ( ! $user_after_update ) { |
|
281 | + gravityview()->log->error( 'User not found at $user_id #{user_id}', array( 'user_id' => $user_id ) ); |
|
282 | + return false; |
|
283 | + } |
|
284 | + |
|
285 | + $restored_user = $user_after_update; |
|
286 | + |
|
287 | + // Restore previous display_name |
|
288 | + $restored_user->display_name = $this->_user_before_update->display_name; |
|
289 | + |
|
290 | + // Don't have WP update the password. |
|
291 | + unset( $restored_user->data->user_pass, $restored_user->user_pass ); |
|
292 | + |
|
293 | + /** |
|
294 | + * Modify the user data after updated by Gravity Forms User Registration but before restored by GravityView |
|
295 | + * @since 1.14 |
|
296 | + * @param WP_User $restored_user The user with restored details about to be updated by wp_update_user() |
|
297 | + * @param WP_User $user_before_update The user before being updated by Gravity Forms User Registration |
|
298 | + * @param WP_User $user_after_update The user after being updated by Gravity Forms User Registration |
|
299 | + * @param array $entry The Gravity Forms entry that was just updated |
|
300 | + */ |
|
301 | + $restored_user = apply_filters( 'gravityview/edit_entry/user_registration/restored_user', $restored_user, $this->_user_before_update, $user_after_update, $entry ); |
|
302 | + |
|
303 | + $updated = wp_update_user( $restored_user ); |
|
304 | + |
|
305 | + if( is_wp_error( $updated ) ) { |
|
306 | + gravityview()->log->error( 'There was an error updating user #{user_id} details', array( 'user_id' => $user_id, 'data' => $updated ) ); |
|
307 | + } else { |
|
308 | + gravityview()->log->debug( 'User #{user_id} details restored', array( 'user_id' => $user_id ) ); |
|
309 | + } |
|
310 | + |
|
311 | + $this->_user_before_update = null; |
|
312 | + |
|
313 | + unset( $restored_user, $user_after_update ); |
|
314 | + |
|
315 | + return $updated; |
|
316 | + } |
|
317 | 317 | |
318 | 318 | } //end class |
@@ -10,175 +10,175 @@ |
||
10 | 10 | */ |
11 | 11 | |
12 | 12 | if ( ! defined( 'WPINC' ) ) { |
13 | - die; |
|
13 | + die; |
|
14 | 14 | } |
15 | 15 | |
16 | 16 | |
17 | 17 | class GravityView_Edit_Entry_Admin { |
18 | 18 | |
19 | - protected $loader; |
|
19 | + protected $loader; |
|
20 | 20 | |
21 | - function __construct( GravityView_Edit_Entry $loader ) { |
|
22 | - $this->loader = $loader; |
|
23 | - } |
|
21 | + function __construct( GravityView_Edit_Entry $loader ) { |
|
22 | + $this->loader = $loader; |
|
23 | + } |
|
24 | 24 | |
25 | - function load() { |
|
26 | - |
|
27 | - if( !is_admin() ) { |
|
28 | - return; |
|
29 | - } |
|
30 | - |
|
31 | - // Add Edit Link as a default field, outside those set in the Gravity Form form |
|
32 | - add_filter( 'gravityview_entry_default_fields', array( $this, 'add_default_field' ), 10, 3 ); |
|
33 | - |
|
34 | - // For the Edit Entry Link, you don't want visible to all users. |
|
35 | - add_filter( 'gravityview_field_visibility_caps', array( $this, 'modify_visibility_caps' ), 10, 5 ); |
|
25 | + function load() { |
|
26 | + |
|
27 | + if( !is_admin() ) { |
|
28 | + return; |
|
29 | + } |
|
30 | + |
|
31 | + // Add Edit Link as a default field, outside those set in the Gravity Form form |
|
32 | + add_filter( 'gravityview_entry_default_fields', array( $this, 'add_default_field' ), 10, 3 ); |
|
33 | + |
|
34 | + // For the Edit Entry Link, you don't want visible to all users. |
|
35 | + add_filter( 'gravityview_field_visibility_caps', array( $this, 'modify_visibility_caps' ), 10, 5 ); |
|
36 | 36 | |
37 | - // Modify the field options based on the name of the field type |
|
38 | - add_filter( 'gravityview_template_edit_link_options', array( $this, 'edit_link_field_options' ), 10, 5 ); |
|
37 | + // Modify the field options based on the name of the field type |
|
38 | + add_filter( 'gravityview_template_edit_link_options', array( $this, 'edit_link_field_options' ), 10, 5 ); |
|
39 | 39 | |
40 | - // add tooltips |
|
41 | - add_filter( 'gravityview/metaboxes/tooltips', array( $this, 'tooltips') ); |
|
42 | - |
|
43 | - // custom fields' options for zone EDIT |
|
44 | - add_filter( 'gravityview_template_field_options', array( $this, 'field_options' ), 10, 5 ); |
|
45 | - } |
|
46 | - |
|
47 | - /** |
|
48 | - * Add Edit Link as a default field, outside those set in the Gravity Form form |
|
49 | - * @param array $entry_default_fields Existing fields |
|
50 | - * @param string|array $form form_ID or form object |
|
51 | - * @param string $zone Either 'single', 'directory', 'header', 'footer' |
|
52 | - */ |
|
53 | - function add_default_field( $entry_default_fields, $form = array(), $zone = '' ) { |
|
54 | - |
|
55 | - if( $zone !== 'edit' ) { |
|
56 | - |
|
57 | - $entry_default_fields['edit_link'] = array( |
|
58 | - 'label' => __('Edit Entry', 'gravityview'), |
|
59 | - 'type' => 'edit_link', |
|
60 | - 'desc' => __('A link to edit the entry. Visible based on View settings.', 'gravityview'), |
|
61 | - ); |
|
62 | - |
|
63 | - } |
|
64 | - |
|
65 | - return $entry_default_fields; |
|
66 | - } |
|
67 | - |
|
68 | - /** |
|
69 | - * Change wording for the Edit context to read Entry Creator |
|
70 | - * |
|
71 | - * @param array $visibility_caps Array of capabilities to display in field dropdown. |
|
72 | - * @param string $field_type Type of field options to render (`field` or `widget`) |
|
73 | - * @param string $template_id Table slug |
|
74 | - * @param float $field_id GF Field ID - Example: `3`, `5.2`, `entry_link`, `created_by` |
|
75 | - * @param string $context What context are we in? Example: `single` or `directory` |
|
76 | - * @param string $input_type (textarea, list, select, etc.) |
|
77 | - * @return array Array of field options with `label`, `value`, `type`, `default` keys |
|
78 | - */ |
|
79 | - function modify_visibility_caps( $visibility_caps = array(), $template_id = '', $field_id = '', $context = '', $input_type = '' ) { |
|
80 | - |
|
81 | - $caps = $visibility_caps; |
|
82 | - |
|
83 | - // If we're configuring fields in the edit context, we want a limited selection |
|
84 | - if( $context === 'edit' ) { |
|
85 | - |
|
86 | - // Remove other built-in caps. |
|
87 | - unset( $caps['publish_posts'], $caps['gravityforms_view_entries'], $caps['delete_others_posts'] ); |
|
88 | - |
|
89 | - $caps['read'] = _x('Entry Creator','User capability', 'gravityview'); |
|
90 | - } |
|
91 | - |
|
92 | - return $caps; |
|
93 | - } |
|
94 | - |
|
95 | - /** |
|
96 | - * Add "Edit Link Text" setting to the edit_link field settings |
|
97 | - * @param [type] $field_options [description] |
|
98 | - * @param [type] $template_id [description] |
|
99 | - * @param [type] $field_id [description] |
|
100 | - * @param [type] $context [description] |
|
101 | - * @param [type] $input_type [description] |
|
102 | - * @return [type] [description] |
|
103 | - */ |
|
104 | - function edit_link_field_options( $field_options, $template_id, $field_id, $context, $input_type ) { |
|
105 | - |
|
106 | - // Always a link, never a filter |
|
107 | - unset( $field_options['show_as_link'], $field_options['search_filter'] ); |
|
108 | - |
|
109 | - // Edit Entry link should only appear to visitors capable of editing entries |
|
110 | - unset( $field_options['only_loggedin'], $field_options['only_loggedin_cap'] ); |
|
111 | - |
|
112 | - $add_option['edit_link'] = array( |
|
113 | - 'type' => 'text', |
|
114 | - 'label' => __( 'Edit Link Text', 'gravityview' ), |
|
115 | - 'desc' => NULL, |
|
116 | - 'value' => __('Edit Entry', 'gravityview'), |
|
117 | - 'merge_tags' => true, |
|
118 | - ); |
|
119 | - |
|
120 | - return array_merge( $add_option, $field_options ); |
|
121 | - } |
|
122 | - |
|
123 | - /** |
|
124 | - * Add tooltips |
|
125 | - * @param array $tooltips Existing tooltips |
|
126 | - * @return array Modified tooltips |
|
127 | - */ |
|
128 | - function tooltips( $tooltips ) { |
|
129 | - |
|
130 | - $return = $tooltips; |
|
131 | - |
|
132 | - $return['allow_edit_cap'] = array( |
|
133 | - 'title' => __('Limiting Edit Access', 'gravityview'), |
|
134 | - 'value' => __('Change this setting if you don\'t want the user who created the entry to be able to edit this field.', 'gravityview'), |
|
135 | - ); |
|
136 | - |
|
137 | - return $return; |
|
138 | - } |
|
139 | - |
|
140 | - /** |
|
141 | - * Manipulate the fields' options for the EDIT ENTRY screen |
|
142 | - * @param [type] $field_options [description] |
|
143 | - * @param [type] $template_id [description] |
|
144 | - * @param [type] $field_id [description] |
|
145 | - * @param [type] $context [description] |
|
146 | - * @param [type] $input_type [description] |
|
147 | - * @return [type] [description] |
|
148 | - */ |
|
149 | - function field_options( $field_options, $template_id, $field_id, $context, $input_type ) { |
|
150 | - |
|
151 | - // We only want to modify the settings for the edit context |
|
152 | - if( 'edit' !== $context ) { |
|
153 | - |
|
154 | - /** |
|
155 | - * @since 1.8.4 |
|
156 | - */ |
|
157 | - $field_options['new_window'] = array( |
|
158 | - 'type' => 'checkbox', |
|
159 | - 'label' => __( 'Open link in a new tab or window?', 'gravityview' ), |
|
160 | - 'value' => false, |
|
161 | - ); |
|
162 | - |
|
163 | - return $field_options; |
|
164 | - } |
|
165 | - |
|
166 | - // Entry field is only for logged in users |
|
167 | - unset( $field_options['only_loggedin'], $field_options['only_loggedin_cap'] ); |
|
168 | - |
|
169 | - $add_options = array( |
|
170 | - 'allow_edit_cap' => array( |
|
171 | - 'type' => 'select', |
|
172 | - 'label' => __( 'Make field editable to:', 'gravityview' ), |
|
173 | - 'choices' => GravityView_Render_Settings::get_cap_choices( $template_id, $field_id, $context, $input_type ), |
|
174 | - 'tooltip' => 'allow_edit_cap', |
|
175 | - 'class' => 'widefat', |
|
176 | - 'value' => 'read', // Default: entry creator |
|
177 | - ), |
|
178 | - ); |
|
179 | - |
|
180 | - return array_merge( $field_options, $add_options ); |
|
181 | - } |
|
40 | + // add tooltips |
|
41 | + add_filter( 'gravityview/metaboxes/tooltips', array( $this, 'tooltips') ); |
|
42 | + |
|
43 | + // custom fields' options for zone EDIT |
|
44 | + add_filter( 'gravityview_template_field_options', array( $this, 'field_options' ), 10, 5 ); |
|
45 | + } |
|
46 | + |
|
47 | + /** |
|
48 | + * Add Edit Link as a default field, outside those set in the Gravity Form form |
|
49 | + * @param array $entry_default_fields Existing fields |
|
50 | + * @param string|array $form form_ID or form object |
|
51 | + * @param string $zone Either 'single', 'directory', 'header', 'footer' |
|
52 | + */ |
|
53 | + function add_default_field( $entry_default_fields, $form = array(), $zone = '' ) { |
|
54 | + |
|
55 | + if( $zone !== 'edit' ) { |
|
56 | + |
|
57 | + $entry_default_fields['edit_link'] = array( |
|
58 | + 'label' => __('Edit Entry', 'gravityview'), |
|
59 | + 'type' => 'edit_link', |
|
60 | + 'desc' => __('A link to edit the entry. Visible based on View settings.', 'gravityview'), |
|
61 | + ); |
|
62 | + |
|
63 | + } |
|
64 | + |
|
65 | + return $entry_default_fields; |
|
66 | + } |
|
67 | + |
|
68 | + /** |
|
69 | + * Change wording for the Edit context to read Entry Creator |
|
70 | + * |
|
71 | + * @param array $visibility_caps Array of capabilities to display in field dropdown. |
|
72 | + * @param string $field_type Type of field options to render (`field` or `widget`) |
|
73 | + * @param string $template_id Table slug |
|
74 | + * @param float $field_id GF Field ID - Example: `3`, `5.2`, `entry_link`, `created_by` |
|
75 | + * @param string $context What context are we in? Example: `single` or `directory` |
|
76 | + * @param string $input_type (textarea, list, select, etc.) |
|
77 | + * @return array Array of field options with `label`, `value`, `type`, `default` keys |
|
78 | + */ |
|
79 | + function modify_visibility_caps( $visibility_caps = array(), $template_id = '', $field_id = '', $context = '', $input_type = '' ) { |
|
80 | + |
|
81 | + $caps = $visibility_caps; |
|
82 | + |
|
83 | + // If we're configuring fields in the edit context, we want a limited selection |
|
84 | + if( $context === 'edit' ) { |
|
85 | + |
|
86 | + // Remove other built-in caps. |
|
87 | + unset( $caps['publish_posts'], $caps['gravityforms_view_entries'], $caps['delete_others_posts'] ); |
|
88 | + |
|
89 | + $caps['read'] = _x('Entry Creator','User capability', 'gravityview'); |
|
90 | + } |
|
91 | + |
|
92 | + return $caps; |
|
93 | + } |
|
94 | + |
|
95 | + /** |
|
96 | + * Add "Edit Link Text" setting to the edit_link field settings |
|
97 | + * @param [type] $field_options [description] |
|
98 | + * @param [type] $template_id [description] |
|
99 | + * @param [type] $field_id [description] |
|
100 | + * @param [type] $context [description] |
|
101 | + * @param [type] $input_type [description] |
|
102 | + * @return [type] [description] |
|
103 | + */ |
|
104 | + function edit_link_field_options( $field_options, $template_id, $field_id, $context, $input_type ) { |
|
105 | + |
|
106 | + // Always a link, never a filter |
|
107 | + unset( $field_options['show_as_link'], $field_options['search_filter'] ); |
|
108 | + |
|
109 | + // Edit Entry link should only appear to visitors capable of editing entries |
|
110 | + unset( $field_options['only_loggedin'], $field_options['only_loggedin_cap'] ); |
|
111 | + |
|
112 | + $add_option['edit_link'] = array( |
|
113 | + 'type' => 'text', |
|
114 | + 'label' => __( 'Edit Link Text', 'gravityview' ), |
|
115 | + 'desc' => NULL, |
|
116 | + 'value' => __('Edit Entry', 'gravityview'), |
|
117 | + 'merge_tags' => true, |
|
118 | + ); |
|
119 | + |
|
120 | + return array_merge( $add_option, $field_options ); |
|
121 | + } |
|
122 | + |
|
123 | + /** |
|
124 | + * Add tooltips |
|
125 | + * @param array $tooltips Existing tooltips |
|
126 | + * @return array Modified tooltips |
|
127 | + */ |
|
128 | + function tooltips( $tooltips ) { |
|
129 | + |
|
130 | + $return = $tooltips; |
|
131 | + |
|
132 | + $return['allow_edit_cap'] = array( |
|
133 | + 'title' => __('Limiting Edit Access', 'gravityview'), |
|
134 | + 'value' => __('Change this setting if you don\'t want the user who created the entry to be able to edit this field.', 'gravityview'), |
|
135 | + ); |
|
136 | + |
|
137 | + return $return; |
|
138 | + } |
|
139 | + |
|
140 | + /** |
|
141 | + * Manipulate the fields' options for the EDIT ENTRY screen |
|
142 | + * @param [type] $field_options [description] |
|
143 | + * @param [type] $template_id [description] |
|
144 | + * @param [type] $field_id [description] |
|
145 | + * @param [type] $context [description] |
|
146 | + * @param [type] $input_type [description] |
|
147 | + * @return [type] [description] |
|
148 | + */ |
|
149 | + function field_options( $field_options, $template_id, $field_id, $context, $input_type ) { |
|
150 | + |
|
151 | + // We only want to modify the settings for the edit context |
|
152 | + if( 'edit' !== $context ) { |
|
153 | + |
|
154 | + /** |
|
155 | + * @since 1.8.4 |
|
156 | + */ |
|
157 | + $field_options['new_window'] = array( |
|
158 | + 'type' => 'checkbox', |
|
159 | + 'label' => __( 'Open link in a new tab or window?', 'gravityview' ), |
|
160 | + 'value' => false, |
|
161 | + ); |
|
162 | + |
|
163 | + return $field_options; |
|
164 | + } |
|
165 | + |
|
166 | + // Entry field is only for logged in users |
|
167 | + unset( $field_options['only_loggedin'], $field_options['only_loggedin_cap'] ); |
|
168 | + |
|
169 | + $add_options = array( |
|
170 | + 'allow_edit_cap' => array( |
|
171 | + 'type' => 'select', |
|
172 | + 'label' => __( 'Make field editable to:', 'gravityview' ), |
|
173 | + 'choices' => GravityView_Render_Settings::get_cap_choices( $template_id, $field_id, $context, $input_type ), |
|
174 | + 'tooltip' => 'allow_edit_cap', |
|
175 | + 'class' => 'widefat', |
|
176 | + 'value' => 'read', // Default: entry creator |
|
177 | + ), |
|
178 | + ); |
|
179 | + |
|
180 | + return array_merge( $field_options, $add_options ); |
|
181 | + } |
|
182 | 182 | |
183 | 183 | |
184 | 184 | } // end class |
185 | 185 | \ No newline at end of file |
@@ -52,14 +52,14 @@ discard block |
||
52 | 52 | // matching regex => the value is the method to call to replace the value. |
53 | 53 | $gv_modifiers = array( |
54 | 54 | 'maxwords:(\d+)' => 'modifier_maxwords', /** @see modifier_maxwords */ |
55 | - 'timestamp' => 'modifier_timestamp', /** @see modifier_timestamp */ |
|
55 | + 'timestamp' => 'modifier_timestamp', /** @see modifier_timestamp */ |
|
56 | 56 | 'explode' => 'modifier_explode', /** @see modifier_explode */ |
57 | 57 | |
58 | 58 | /** @see modifier_strings */ |
59 | 59 | 'urlencode' => 'modifier_strings', |
60 | 60 | 'wpautop' => 'modifier_strings', |
61 | - 'esc_html' => 'modifier_strings', |
|
62 | - 'sanitize_html_class' => 'modifier_strings', |
|
61 | + 'esc_html' => 'modifier_strings', |
|
62 | + 'sanitize_html_class' => 'modifier_strings', |
|
63 | 63 | 'sanitize_title' => 'modifier_strings', |
64 | 64 | 'strtolower' => 'modifier_strings', |
65 | 65 | 'strtoupper' => 'modifier_strings', |
@@ -457,7 +457,7 @@ discard block |
||
457 | 457 | |
458 | 458 | $atts = array( |
459 | 459 | 'format' => self::get_format_from_modifiers( $exploded, false ), |
460 | - 'human' => in_array( 'human', $exploded ), // {date_created:human} |
|
460 | + 'human' => in_array( 'human', $exploded ), // {date_created:human} |
|
461 | 461 | 'diff' => in_array( 'diff', $exploded ), // {date_created:diff} |
462 | 462 | 'raw' => in_array( 'raw', $exploded ), // {date_created:raw} |
463 | 463 | 'timestamp' => in_array( 'timestamp', $exploded ), // {date_created:timestamp} |
@@ -109,7 +109,7 @@ |
||
109 | 109 | $field_data = array( |
110 | 110 | 'label' => \GV\Utils::get( $edit_field, 'custom_label' ), |
111 | 111 | 'customLabel' => \GV\Utils::get( $edit_field, 'custom_label' ), |
112 | - 'content' => \GV\Utils::get( $edit_field, 'content' ), |
|
112 | + 'content' => \GV\Utils::get( $edit_field, 'content' ), |
|
113 | 113 | ); |
114 | 114 | |
115 | 115 | // Replace merge tags in the content |
@@ -35,7 +35,7 @@ discard block |
||
35 | 35 | } |
36 | 36 | |
37 | 37 | private function add_hooks() { |
38 | - /** @see \GV\Field::get_value_filters */ |
|
38 | + /** @see \GV\Field::get_value_filters */ |
|
39 | 39 | add_filter( "gravityview/field/{$this->name}/output", array( $this, 'get_content' ), 4, 2 ); |
40 | 40 | add_action( 'gravityview/template/after', array( $this, 'print_script'), 10, 1 ); |
41 | 41 | add_filter( 'gravityview_entry_default_fields', array( $this, 'add_default_field' ), 10, 3 ); |
@@ -76,7 +76,7 @@ discard block |
||
76 | 76 | public function get_content( $output, $template ) { |
77 | 77 | $entry = $template->entry; |
78 | 78 | |
79 | - $star_url = GFCommon::get_base_url() .'/images/star' . intval( $entry['is_starred'] ) .'.png'; |
|
79 | + $star_url = GFCommon::get_base_url() .'/images/star' . intval( $entry['is_starred'] ) .'.png'; |
|
80 | 80 | |
81 | 81 | $entry_id = ''; |
82 | 82 | |
@@ -94,11 +94,11 @@ discard block |
||
94 | 94 | |
95 | 95 | /** |
96 | 96 | * Add JS to the bottom of the View if there is a star field and user has `gravityview_edit_entries` cap |
97 | - * |
|
97 | + * |
|
98 | 98 | * @param \GV\Template_Context $context The template context |
99 | - * @since 2.0 |
|
100 | - * |
|
101 | - * @return void |
|
99 | + * @since 2.0 |
|
100 | + * |
|
101 | + * @return void |
|
102 | 102 | */ |
103 | 103 | public function print_script( $context ) { |
104 | 104 | |
@@ -107,7 +107,7 @@ discard block |
||
107 | 107 | } |
108 | 108 | |
109 | 109 | if ( ! GravityView_Roles_Capabilities::has_cap( 'gravityview_edit_entries' ) ) { |
110 | - return; |
|
110 | + return; |
|
111 | 111 | } |
112 | 112 | |
113 | 113 | ?> |
@@ -328,34 +328,34 @@ discard block |
||
328 | 328 | } |
329 | 329 | |
330 | 330 | /** |
331 | - * Get the fields for a specific context |
|
332 | - * |
|
333 | - * @since 1.19.2 |
|
334 | - * |
|
331 | + * Get the fields for a specific context |
|
332 | + * |
|
333 | + * @since 1.19.2 |
|
334 | + * |
|
335 | 335 | * @param string $context [Optional] "directory", "single", or "edit" |
336 | 336 | * |
337 | 337 | * @return array Array of GravityView field layout configurations |
338 | 338 | */ |
339 | 339 | public function getContextFields( $context = '' ) { |
340 | 340 | |
341 | - if( '' === $context ) { |
|
342 | - $context = $this->getContext(); |
|
343 | - } |
|
341 | + if( '' === $context ) { |
|
342 | + $context = $this->getContext(); |
|
343 | + } |
|
344 | 344 | |
345 | 345 | $fields = $this->getFields(); |
346 | 346 | |
347 | - foreach ( (array) $fields as $key => $context_fields ) { |
|
347 | + foreach ( (array) $fields as $key => $context_fields ) { |
|
348 | 348 | |
349 | - // Formatted as `{context}_{template id}-{zone name}`, so we want just the $context to match against |
|
350 | - $matches = explode( '_', $key ); |
|
349 | + // Formatted as `{context}_{template id}-{zone name}`, so we want just the $context to match against |
|
350 | + $matches = explode( '_', $key ); |
|
351 | 351 | |
352 | - if( isset( $matches[0] ) && $matches[0] === $context ) { |
|
353 | - return $context_fields; |
|
354 | - } |
|
355 | - } |
|
352 | + if( isset( $matches[0] ) && $matches[0] === $context ) { |
|
353 | + return $context_fields; |
|
354 | + } |
|
355 | + } |
|
356 | 356 | |
357 | 357 | return array(); |
358 | - } |
|
358 | + } |
|
359 | 359 | |
360 | 360 | /** |
361 | 361 | * @param array $fields |
@@ -448,10 +448,10 @@ discard block |
||
448 | 448 | */ |
449 | 449 | public function getPaging() { |
450 | 450 | |
451 | - $default_params = array( |
|
452 | - 'offset' => 0, |
|
453 | - 'page_size' => 20, |
|
454 | - ); |
|
451 | + $default_params = array( |
|
452 | + 'offset' => 0, |
|
453 | + 'page_size' => 20, |
|
454 | + ); |
|
455 | 455 | |
456 | 456 | return wp_parse_args( $this->paging, $default_params ); |
457 | 457 | } |
@@ -508,10 +508,10 @@ discard block |
||
508 | 508 | public function getSorting() { |
509 | 509 | |
510 | 510 | $defaults_params = array( |
511 | - 'sort_field' => 'date_created', |
|
512 | - 'sort_direction' => 'ASC', |
|
513 | - 'is_numeric' => false, |
|
514 | - ); |
|
511 | + 'sort_field' => 'date_created', |
|
512 | + 'sort_direction' => 'ASC', |
|
513 | + 'is_numeric' => false, |
|
514 | + ); |
|
515 | 515 | |
516 | 516 | return wp_parse_args( $this->sorting, $defaults_params ); |
517 | 517 | } |
@@ -837,7 +837,7 @@ discard block |
||
837 | 837 | */ |
838 | 838 | public function render_widget_hooks( $view_id_or_context ) { |
839 | 839 | |
840 | - /** |
|
840 | + /** |
|
841 | 841 | * @deprecated Numeric argument is deprecated. Pass a \GV\Template_Context instead. |
842 | 842 | */ |
843 | 843 | if ( is_numeric( $view_id_or_context ) ) { |
@@ -175,10 +175,10 @@ discard block |
||
175 | 175 | |
176 | 176 | if( 'gv_note_add' === $_POST['action'] ) { |
177 | 177 | |
178 | - if( ! GVCommon::has_cap( 'gravityview_add_entry_notes' ) ) { |
|
179 | - do_action( 'gravityview_log_error', __METHOD__ . ': The user isnt allowed to add entry notes.' ); |
|
180 | - return; |
|
181 | - } |
|
178 | + if( ! GVCommon::has_cap( 'gravityview_add_entry_notes' ) ) { |
|
179 | + do_action( 'gravityview_log_error', __METHOD__ . ': The user isnt allowed to add entry notes.' ); |
|
180 | + return; |
|
181 | + } |
|
182 | 182 | |
183 | 183 | $post = wp_unslash( $_POST ); |
184 | 184 | |
@@ -278,7 +278,7 @@ discard block |
||
278 | 278 | * |
279 | 279 | * Verify permissions. Check expected $_POST. Parse args, then send to process_delete_notes |
280 | 280 | * |
281 | - * @since 1.17 |
|
281 | + * @since 1.17 |
|
282 | 282 | * |
283 | 283 | * @see process_delete_notes |
284 | 284 | * |
@@ -431,7 +431,7 @@ discard block |
||
431 | 431 | 'subject-label' => __( 'Subject', 'gravityview' ), |
432 | 432 | 'subject' => __( 'Email subject', 'gravityview' ), |
433 | 433 | 'default-email-subject' => __( 'New entry note', 'gravityview' ), |
434 | - 'email-footer' => __( 'This note was sent from {url}', 'gravityview' ), |
|
434 | + 'email-footer' => __( 'This note was sent from {url}', 'gravityview' ), |
|
435 | 435 | 'also-email' => __( 'Also email this note to', 'gravityview' ), |
436 | 436 | 'error-add-note' => __( 'There was an error adding the note.', 'gravityview' ), |
437 | 437 | 'error-invalid' => __( 'The request was invalid. Refresh the page and try again.', 'gravityview' ), |
@@ -501,11 +501,11 @@ discard block |
||
501 | 501 | |
502 | 502 | if ( $context instanceof \GV\Template_Context ) { |
503 | 503 | |
504 | - ob_start(); |
|
505 | - $context->template->get_template_part( 'note', 'detail', true ); |
|
506 | - $note_detail_html = ob_get_clean(); |
|
504 | + ob_start(); |
|
505 | + $context->template->get_template_part( 'note', 'detail', true ); |
|
506 | + $note_detail_html = ob_get_clean(); |
|
507 | 507 | |
508 | - ob_start(); |
|
508 | + ob_start(); |
|
509 | 509 | $context->template->get_template_part( 'note', $note_row_template, true ); |
510 | 510 | $note_row = ob_get_clean(); |
511 | 511 | } else { |
@@ -761,7 +761,7 @@ discard block |
||
761 | 761 | 'gv-note-to-custom' => '', |
762 | 762 | 'gv-note-subject' => '', |
763 | 763 | 'gv-note-content' => '', |
764 | - 'current-url' => '', |
|
764 | + 'current-url' => '', |
|
765 | 765 | ); |
766 | 766 | |
767 | 767 | $current_user = wp_get_current_user(); |
@@ -813,9 +813,9 @@ discard block |
||
813 | 813 | $message .= $this->get_email_footer( $email_footer, $is_html, $email_data ); |
814 | 814 | |
815 | 815 | /** |
816 | - * @filter `gravityview/field/notes/wpautop_email` Should the message content have paragraphs added automatically, if using HTML message format |
|
816 | + * @filter `gravityview/field/notes/wpautop_email` Should the message content have paragraphs added automatically, if using HTML message format |
|
817 | 817 | * @since 1.18 |
818 | - * @param bool $wpautop_email True: Apply wpautop() to the email message if using; False: Leave as entered (Default: true) |
|
818 | + * @param bool $wpautop_email True: Apply wpautop() to the email message if using; False: Leave as entered (Default: true) |
|
819 | 819 | */ |
820 | 820 | $wpautop_email = apply_filters( 'gravityview/field/notes/wpautop_email', true ); |
821 | 821 | |
@@ -835,12 +835,12 @@ discard block |
||
835 | 835 | } |
836 | 836 | |
837 | 837 | /** |
838 | - * Get the footer for Entry Note emails |
|
839 | - * |
|
840 | - * `{url}` is replaced by the URL of the page where the note form was embedded |
|
841 | - * |
|
842 | - * @since 1.18 |
|
843 | - * @see GravityView_Field_Notes::strings The default value of $message_footer is set here, with the key 'email-footer' |
|
838 | + * Get the footer for Entry Note emails |
|
839 | + * |
|
840 | + * `{url}` is replaced by the URL of the page where the note form was embedded |
|
841 | + * |
|
842 | + * @since 1.18 |
|
843 | + * @see GravityView_Field_Notes::strings The default value of $message_footer is set here, with the key 'email-footer' |
|
844 | 844 | * |
845 | 845 | * @param string $email_footer The message footer value |
846 | 846 | * @param bool $is_html True: Email is being sent as HTML; False: sent as text |
@@ -849,10 +849,10 @@ discard block |
||
849 | 849 | */ |
850 | 850 | private function get_email_footer( $email_footer = '', $is_html = true, $email_data = array() ) { |
851 | 851 | |
852 | - $output = ''; |
|
852 | + $output = ''; |
|
853 | 853 | |
854 | 854 | if( ! empty( $email_footer ) ) { |
855 | - $url = \GV\Utils::get( $email_data, 'current-url' ); |
|
855 | + $url = \GV\Utils::get( $email_data, 'current-url' ); |
|
856 | 856 | $url = html_entity_decode( $url ); |
857 | 857 | $url = site_url( $url ); |
858 | 858 |
@@ -305,12 +305,12 @@ discard block |
||
305 | 305 | } |
306 | 306 | |
307 | 307 | /** |
308 | - * @hack |
|
309 | - * In case of email/email confirmation, the input for email has the same id as the parent field |
|
310 | - */ |
|
308 | + * @hack |
|
309 | + * In case of email/email confirmation, the input for email has the same id as the parent field |
|
310 | + */ |
|
311 | 311 | if( 'email' === $field['type'] && false === strpos( $input['id'], '.' ) ) { |
312 | - continue; |
|
313 | - } |
|
312 | + continue; |
|
313 | + } |
|
314 | 314 | $fields["{$input['id']}"] = array( |
315 | 315 | 'label' => \GV\Utils::get( $input, 'label' ), |
316 | 316 | 'customLabel' => \GV\Utils::get( $input, 'customLabel' ), |
@@ -1349,7 +1349,7 @@ discard block |
||
1349 | 1349 | ), |
1350 | 1350 | ); |
1351 | 1351 | |
1352 | - $fields = $date_created + $fields; |
|
1352 | + $fields = $date_created + $fields; |
|
1353 | 1353 | |
1354 | 1354 | $blacklist_field_types = apply_filters( 'gravityview_blacklist_field_types', $blacklist, NULL ); |
1355 | 1355 | |
@@ -1361,13 +1361,13 @@ discard block |
||
1361 | 1361 | } |
1362 | 1362 | } |
1363 | 1363 | |
1364 | - /** |
|
1365 | - * @filter `gravityview/common/sortable_fields` Filter the sortable fields |
|
1366 | - * @since 1.12 |
|
1367 | - * @param array $fields Sub-set of GF form fields that are sortable |
|
1368 | - * @param int $formid The Gravity Forms form ID that the fields are from |
|
1369 | - */ |
|
1370 | - $fields = apply_filters( 'gravityview/common/sortable_fields', $fields, $formid ); |
|
1364 | + /** |
|
1365 | + * @filter `gravityview/common/sortable_fields` Filter the sortable fields |
|
1366 | + * @since 1.12 |
|
1367 | + * @param array $fields Sub-set of GF form fields that are sortable |
|
1368 | + * @param int $formid The Gravity Forms form ID that the fields are from |
|
1369 | + */ |
|
1370 | + $fields = apply_filters( 'gravityview/common/sortable_fields', $fields, $formid ); |
|
1371 | 1371 | |
1372 | 1372 | return $fields; |
1373 | 1373 | } |
@@ -1659,26 +1659,26 @@ discard block |
||
1659 | 1659 | } |
1660 | 1660 | |
1661 | 1661 | |
1662 | - /** |
|
1663 | - * Display updated/error notice |
|
1664 | - * |
|
1665 | - * @since 1.19.2 Added $cap and $object_id parameters |
|
1666 | - * |
|
1667 | - * @param string $notice text/HTML of notice |
|
1668 | - * @param string $class CSS class for notice (`updated` or `error`) |
|
1669 | - * @param string $cap [Optional] Define a capability required to show a notice. If not set, displays to all caps. |
|
1670 | - * |
|
1671 | - * @return string |
|
1672 | - */ |
|
1673 | - public static function generate_notice( $notice, $class = '', $cap = '', $object_id = null ) { |
|
1674 | - |
|
1675 | - // If $cap is defined, only show notice if user has capability |
|
1676 | - if( $cap && ! GVCommon::has_cap( $cap, $object_id ) ) { |
|
1677 | - return ''; |
|
1678 | - } |
|
1679 | - |
|
1680 | - return '<div class="gv-notice '.gravityview_sanitize_html_class( $class ) .'">'. $notice .'</div>'; |
|
1681 | - } |
|
1662 | + /** |
|
1663 | + * Display updated/error notice |
|
1664 | + * |
|
1665 | + * @since 1.19.2 Added $cap and $object_id parameters |
|
1666 | + * |
|
1667 | + * @param string $notice text/HTML of notice |
|
1668 | + * @param string $class CSS class for notice (`updated` or `error`) |
|
1669 | + * @param string $cap [Optional] Define a capability required to show a notice. If not set, displays to all caps. |
|
1670 | + * |
|
1671 | + * @return string |
|
1672 | + */ |
|
1673 | + public static function generate_notice( $notice, $class = '', $cap = '', $object_id = null ) { |
|
1674 | + |
|
1675 | + // If $cap is defined, only show notice if user has capability |
|
1676 | + if( $cap && ! GVCommon::has_cap( $cap, $object_id ) ) { |
|
1677 | + return ''; |
|
1678 | + } |
|
1679 | + |
|
1680 | + return '<div class="gv-notice '.gravityview_sanitize_html_class( $class ) .'">'. $notice .'</div>'; |
|
1681 | + } |
|
1682 | 1682 | |
1683 | 1683 | /** |
1684 | 1684 | * Inspired on \GFCommon::encode_shortcodes, reverse the encoding by replacing the ascii characters by the shortcode brackets |
@@ -151,11 +151,11 @@ discard block |
||
151 | 151 | do_action( 'gravityview/template/list/body/before', $context ); |
152 | 152 | |
153 | 153 | /** |
154 | - * @action `gravityview_list_body_before` Inside the `tbody`, before any rows are rendered. Can be used to insert additional rows. |
|
155 | - * @deprecated Use `gravityview/template/list/body/before` |
|
156 | - * @since 1.0.7 |
|
157 | - * @param \GravityView_View $gravityview_view Current GravityView_View object. |
|
158 | - */ |
|
154 | + * @action `gravityview_list_body_before` Inside the `tbody`, before any rows are rendered. Can be used to insert additional rows. |
|
155 | + * @deprecated Use `gravityview/template/list/body/before` |
|
156 | + * @since 1.0.7 |
|
157 | + * @param \GravityView_View $gravityview_view Current GravityView_View object. |
|
158 | + */ |
|
159 | 159 | do_action( 'gravityview_list_body_before', \GravityView_View::getInstance() /** ugh! */ ); |
160 | 160 | } |
161 | 161 | |
@@ -177,11 +177,11 @@ discard block |
||
177 | 177 | do_action( 'gravityview/template/list/body/after', $context ); |
178 | 178 | |
179 | 179 | /** |
180 | - * @action `gravityview_list_body_after` Inside the `tbody`, after any rows are rendered. Can be used to insert additional rows. |
|
181 | - * @deprecated Use `gravityview/template/list/body/after` |
|
182 | - * @since 1.0.7 |
|
183 | - * @param \GravityView_View $gravityview_view Current GravityView_View object. |
|
184 | - */ |
|
180 | + * @action `gravityview_list_body_after` Inside the `tbody`, after any rows are rendered. Can be used to insert additional rows. |
|
181 | + * @deprecated Use `gravityview/template/list/body/after` |
|
182 | + * @since 1.0.7 |
|
183 | + * @param \GravityView_View $gravityview_view Current GravityView_View object. |
|
184 | + */ |
|
185 | 185 | do_action( 'gravityview_list_body_after', \GravityView_View::getInstance() /** ugh! */ ); |
186 | 186 | } |
187 | 187 | |
@@ -212,11 +212,11 @@ discard block |
||
212 | 212 | $zone = str_replace( '/', '_', $zone ); |
213 | 213 | |
214 | 214 | /** |
215 | - * @action `gravityview_list_entry_$zone_before` Inside the `entry`, before any rows are rendered. Can be used to insert additional rows. |
|
216 | - * @deprecated Use `gravityview/template/list/entry/$zone/before` |
|
217 | - * @since 1.0.7 |
|
218 | - * @param \GravityView_View $gravityview_view Current GravityView_View object. |
|
219 | - */ |
|
215 | + * @action `gravityview_list_entry_$zone_before` Inside the `entry`, before any rows are rendered. Can be used to insert additional rows. |
|
216 | + * @deprecated Use `gravityview/template/list/entry/$zone/before` |
|
217 | + * @since 1.0.7 |
|
218 | + * @param \GravityView_View $gravityview_view Current GravityView_View object. |
|
219 | + */ |
|
220 | 220 | do_action( sprintf( 'gravityview_list_entry%sbefore', $zone ), $entry->as_entry(), \GravityView_View::getInstance() /** ugh! */ ); |
221 | 221 | } |
222 | 222 | |
@@ -247,11 +247,11 @@ discard block |
||
247 | 247 | $zone = str_replace( '/', '_', $zone ); |
248 | 248 | |
249 | 249 | /** |
250 | - * @action `gravityview_list_entry_$zone_after` Inside the `entry`, after any rows are rendered. Can be used to insert additional rows. |
|
251 | - * @deprecated Use `gravityview/template/list/entry/after` |
|
252 | - * @since 1.0.7 |
|
253 | - * @param \GravityView_View $gravityview_view Current GravityView_View object. |
|
254 | - */ |
|
250 | + * @action `gravityview_list_entry_$zone_after` Inside the `entry`, after any rows are rendered. Can be used to insert additional rows. |
|
251 | + * @deprecated Use `gravityview/template/list/entry/after` |
|
252 | + * @since 1.0.7 |
|
253 | + * @param \GravityView_View $gravityview_view Current GravityView_View object. |
|
254 | + */ |
|
255 | 255 | do_action( sprintf( 'gravityview_list_entry%safter', $zone ), $entry->as_entry(), \GravityView_View::getInstance() /** ugh! */ ); |
256 | 256 | } |
257 | 257 | } |