@@ -10,107 +10,107 @@ discard block |
||
| 10 | 10 | * |
| 11 | 11 | * @var string |
| 12 | 12 | */ |
| 13 | - protected $name; |
|
| 13 | + protected $name; |
|
| 14 | 14 | |
| 15 | 15 | /** |
| 16 | 16 | * Field settings |
| 17 | 17 | * |
| 18 | 18 | * @var array |
| 19 | 19 | */ |
| 20 | - protected $field; |
|
| 20 | + protected $field; |
|
| 21 | 21 | |
| 22 | 22 | /** |
| 23 | 23 | * Field current value |
| 24 | 24 | * |
| 25 | 25 | * @var mixed |
| 26 | 26 | */ |
| 27 | - protected $value; |
|
| 28 | - |
|
| 29 | - function __construct( $name = '', $field = array(), $curr_value = NULL ) { |
|
| 30 | - |
|
| 31 | - $this->name = $name; |
|
| 32 | - |
|
| 33 | - $defaults = self::get_field_defaults(); |
|
| 34 | - |
|
| 35 | - // Backward compatibility |
|
| 36 | - if( !empty( $field['choices'] ) ) { |
|
| 37 | - $field['options'] = $field['choices']; |
|
| 38 | - unset( $field['choices'] ); |
|
| 39 | - } |
|
| 40 | - |
|
| 41 | - $this->field = wp_parse_args( $field, $defaults ); |
|
| 42 | - |
|
| 43 | - $this->value = is_null( $curr_value ) ? $this->field['value'] : $curr_value; |
|
| 44 | - |
|
| 45 | - } |
|
| 46 | - |
|
| 47 | - /** |
|
| 48 | - * Returns the default details for a field option |
|
| 49 | - * |
|
| 50 | - * - default // default option value, in case nothing is defined (@deprecated) |
|
| 51 | - * - desc // option description |
|
| 52 | - * - value // the option default value |
|
| 53 | - * - label // the option label |
|
| 54 | - * - left_label // In case of checkboxes, left label will appear on the left of the checkbox |
|
| 55 | - * - id // the field id |
|
| 56 | - * - type // the option type ( text, checkbox, select, ... ) |
|
| 57 | - * - options // when type is select, define the select options ('choices' is @deprecated) |
|
| 58 | - * - merge_tags // if the option supports merge tags feature |
|
| 59 | - * - class // (new) define extra classes for the field |
|
| 60 | - * - tooltip // |
|
| 61 | - * |
|
| 62 | - * @return array |
|
| 63 | - */ |
|
| 64 | - public static function get_field_defaults() { |
|
| 65 | - return array( |
|
| 66 | - 'desc' => '', |
|
| 67 | - 'value' => null, |
|
| 68 | - 'label' => '', |
|
| 69 | - 'left_label' => null, |
|
| 70 | - 'id' => null, |
|
| 71 | - 'type' => 'text', |
|
| 72 | - 'options' => null, |
|
| 73 | - 'merge_tags' => true, |
|
| 74 | - 'class' => '', |
|
| 75 | - 'tooltip' => null, |
|
| 76 | - 'requires' => null |
|
| 77 | - ); |
|
| 78 | - } |
|
| 79 | - |
|
| 80 | - |
|
| 81 | - function get_tooltip() { |
|
| 82 | - if( ! function_exists('gform_tooltip') ) { |
|
| 83 | - return null; |
|
| 84 | - } |
|
| 85 | - |
|
| 86 | - $article = wp_parse_args( \GV\Utils::get( $this->field, 'article', array() ), array( |
|
| 87 | - 'id' => '', |
|
| 88 | - 'type' => 'modal', |
|
| 89 | - 'url' => '#', |
|
| 90 | - ) ); |
|
| 91 | - |
|
| 92 | - return !empty( $this->field['tooltip'] ) ? ' '. $this->tooltip( $this->field['tooltip'], false, true, $article ) : null; |
|
| 93 | - } |
|
| 94 | - |
|
| 95 | - /** |
|
| 96 | - * Displays the tooltip |
|
| 97 | - * |
|
| 98 | - * @since 2.8.1 |
|
| 99 | - * |
|
| 100 | - * @global $__gf_tooltips |
|
| 101 | - * |
|
| 102 | - * @param string $name The name of the tooltip to be displayed |
|
| 103 | - * @param string $css_class Optional. The CSS class to apply toi the element. Defaults to empty string. |
|
| 104 | - * @param bool $return Optional. If the tooltip should be returned instead of output. Defaults to false (output) |
|
| 105 | - * @param array $article Optional. Details about support doc article connected to the tooltip. { |
|
| 106 | - * @type string $id Unique ID of article for Beacon API |
|
| 107 | - * @type string $url URL of support doc article |
|
| 108 | - * @type string $type Type of Beacon element to open. {@see https://developer.helpscout.com/beacon-2/web/javascript-api/#beaconarticle} |
|
| 109 | - * } |
|
| 110 | - * |
|
| 111 | - * @return string |
|
| 112 | - */ |
|
| 113 | - function tooltip( $name, $css_class = '', $return = false, $article = array() ) { |
|
| 27 | + protected $value; |
|
| 28 | + |
|
| 29 | + function __construct( $name = '', $field = array(), $curr_value = NULL ) { |
|
| 30 | + |
|
| 31 | + $this->name = $name; |
|
| 32 | + |
|
| 33 | + $defaults = self::get_field_defaults(); |
|
| 34 | + |
|
| 35 | + // Backward compatibility |
|
| 36 | + if( !empty( $field['choices'] ) ) { |
|
| 37 | + $field['options'] = $field['choices']; |
|
| 38 | + unset( $field['choices'] ); |
|
| 39 | + } |
|
| 40 | + |
|
| 41 | + $this->field = wp_parse_args( $field, $defaults ); |
|
| 42 | + |
|
| 43 | + $this->value = is_null( $curr_value ) ? $this->field['value'] : $curr_value; |
|
| 44 | + |
|
| 45 | + } |
|
| 46 | + |
|
| 47 | + /** |
|
| 48 | + * Returns the default details for a field option |
|
| 49 | + * |
|
| 50 | + * - default // default option value, in case nothing is defined (@deprecated) |
|
| 51 | + * - desc // option description |
|
| 52 | + * - value // the option default value |
|
| 53 | + * - label // the option label |
|
| 54 | + * - left_label // In case of checkboxes, left label will appear on the left of the checkbox |
|
| 55 | + * - id // the field id |
|
| 56 | + * - type // the option type ( text, checkbox, select, ... ) |
|
| 57 | + * - options // when type is select, define the select options ('choices' is @deprecated) |
|
| 58 | + * - merge_tags // if the option supports merge tags feature |
|
| 59 | + * - class // (new) define extra classes for the field |
|
| 60 | + * - tooltip // |
|
| 61 | + * |
|
| 62 | + * @return array |
|
| 63 | + */ |
|
| 64 | + public static function get_field_defaults() { |
|
| 65 | + return array( |
|
| 66 | + 'desc' => '', |
|
| 67 | + 'value' => null, |
|
| 68 | + 'label' => '', |
|
| 69 | + 'left_label' => null, |
|
| 70 | + 'id' => null, |
|
| 71 | + 'type' => 'text', |
|
| 72 | + 'options' => null, |
|
| 73 | + 'merge_tags' => true, |
|
| 74 | + 'class' => '', |
|
| 75 | + 'tooltip' => null, |
|
| 76 | + 'requires' => null |
|
| 77 | + ); |
|
| 78 | + } |
|
| 79 | + |
|
| 80 | + |
|
| 81 | + function get_tooltip() { |
|
| 82 | + if( ! function_exists('gform_tooltip') ) { |
|
| 83 | + return null; |
|
| 84 | + } |
|
| 85 | + |
|
| 86 | + $article = wp_parse_args( \GV\Utils::get( $this->field, 'article', array() ), array( |
|
| 87 | + 'id' => '', |
|
| 88 | + 'type' => 'modal', |
|
| 89 | + 'url' => '#', |
|
| 90 | + ) ); |
|
| 91 | + |
|
| 92 | + return !empty( $this->field['tooltip'] ) ? ' '. $this->tooltip( $this->field['tooltip'], false, true, $article ) : null; |
|
| 93 | + } |
|
| 94 | + |
|
| 95 | + /** |
|
| 96 | + * Displays the tooltip |
|
| 97 | + * |
|
| 98 | + * @since 2.8.1 |
|
| 99 | + * |
|
| 100 | + * @global $__gf_tooltips |
|
| 101 | + * |
|
| 102 | + * @param string $name The name of the tooltip to be displayed |
|
| 103 | + * @param string $css_class Optional. The CSS class to apply toi the element. Defaults to empty string. |
|
| 104 | + * @param bool $return Optional. If the tooltip should be returned instead of output. Defaults to false (output) |
|
| 105 | + * @param array $article Optional. Details about support doc article connected to the tooltip. { |
|
| 106 | + * @type string $id Unique ID of article for Beacon API |
|
| 107 | + * @type string $url URL of support doc article |
|
| 108 | + * @type string $type Type of Beacon element to open. {@see https://developer.helpscout.com/beacon-2/web/javascript-api/#beaconarticle} |
|
| 109 | + * } |
|
| 110 | + * |
|
| 111 | + * @return string |
|
| 112 | + */ |
|
| 113 | + function tooltip( $name, $css_class = '', $return = false, $article = array() ) { |
|
| 114 | 114 | global $__gf_tooltips; //declared as global to improve WPML performance |
| 115 | 115 | |
| 116 | 116 | $css_class = empty( $css_class ) ? 'tooltip' : $css_class; |
@@ -128,17 +128,17 @@ discard block |
||
| 128 | 128 | $tooltip_class = isset( $__gf_tooltips[ $name ] ) ? "tooltip_{$name}" : ''; |
| 129 | 129 | $tooltip_class = esc_attr( $tooltip_class ); |
| 130 | 130 | |
| 131 | - /** |
|
| 132 | - * Below this line has been modified by GravityView. |
|
| 133 | - */ |
|
| 131 | + /** |
|
| 132 | + * Below this line has been modified by GravityView. |
|
| 133 | + */ |
|
| 134 | 134 | |
| 135 | 135 | if ( empty( $tooltip_text ) && empty( $article['id'] ) ) { |
| 136 | 136 | return ''; |
| 137 | 137 | } |
| 138 | 138 | |
| 139 | 139 | $url = '#'; |
| 140 | - $atts = 'onclick="return false;" onkeypress="return false;"'; |
|
| 141 | - $anchor_text = '<i class=\'fa fa-question-circle\'></i>'; |
|
| 140 | + $atts = 'onclick="return false;" onkeypress="return false;"'; |
|
| 141 | + $anchor_text = '<i class=\'fa fa-question-circle\'></i>'; |
|
| 142 | 142 | $css_class = gravityview_sanitize_html_class( 'gf_tooltip ' . $css_class . ' ' . $tooltip_class ); |
| 143 | 143 | |
| 144 | 144 | $tooltip = sprintf( '<a href="%s" %s class="%s" title="%s" role="button">%s</a>', |
@@ -149,11 +149,11 @@ discard block |
||
| 149 | 149 | $anchor_text |
| 150 | 150 | ); |
| 151 | 151 | |
| 152 | - /** |
|
| 153 | - * Modify the tooltip HTML before outputting |
|
| 154 | - * @internal |
|
| 155 | - * @see GravityView_Support_Port::maybe_add_article_to_tooltip() |
|
| 156 | - */ |
|
| 152 | + /** |
|
| 153 | + * Modify the tooltip HTML before outputting |
|
| 154 | + * @internal |
|
| 155 | + * @see GravityView_Support_Port::maybe_add_article_to_tooltip() |
|
| 156 | + */ |
|
| 157 | 157 | $tooltip = apply_filters( 'gravityview/tooltips/tooltip', $tooltip, $article, $url, $atts, $css_class, $tooltip_text, $anchor_text ); |
| 158 | 158 | |
| 159 | 159 | if ( ! $return ) { |
@@ -163,84 +163,84 @@ discard block |
||
| 163 | 163 | return $tooltip; |
| 164 | 164 | } |
| 165 | 165 | |
| 166 | - /** |
|
| 167 | - * Build input id based on the name |
|
| 168 | - * @return string |
|
| 169 | - */ |
|
| 170 | - function get_field_id() { |
|
| 171 | - if( isset( $this->field['id'] ) ) { |
|
| 172 | - return esc_attr( $this->field['id'] ); |
|
| 173 | - } |
|
| 174 | - return esc_attr( sanitize_html_class( $this->name ) ); |
|
| 175 | - } |
|
| 176 | - |
|
| 177 | - /** |
|
| 178 | - * Retrieve field label |
|
| 179 | - * @return string |
|
| 180 | - */ |
|
| 181 | - function get_field_label() { |
|
| 182 | - return esc_html( trim( $this->field['label'] ) ); |
|
| 183 | - } |
|
| 166 | + /** |
|
| 167 | + * Build input id based on the name |
|
| 168 | + * @return string |
|
| 169 | + */ |
|
| 170 | + function get_field_id() { |
|
| 171 | + if( isset( $this->field['id'] ) ) { |
|
| 172 | + return esc_attr( $this->field['id'] ); |
|
| 173 | + } |
|
| 174 | + return esc_attr( sanitize_html_class( $this->name ) ); |
|
| 175 | + } |
|
| 176 | + |
|
| 177 | + /** |
|
| 178 | + * Retrieve field label |
|
| 179 | + * @return string |
|
| 180 | + */ |
|
| 181 | + function get_field_label() { |
|
| 182 | + return esc_html( trim( $this->field['label'] ) ); |
|
| 183 | + } |
|
| 184 | 184 | |
| 185 | 185 | /** |
| 186 | 186 | * Retrieve field left label |
| 187 | - * |
|
| 188 | - * @since 1.7 |
|
| 189 | - * |
|
| 187 | + * |
|
| 188 | + * @since 1.7 |
|
| 189 | + * |
|
| 190 | 190 | * @return string |
| 191 | 191 | */ |
| 192 | 192 | function get_field_left_label() { |
| 193 | 193 | return ! empty( $this->field['left_label'] ) ? esc_html( trim( $this->field['left_label'] ) ) : NULL; |
| 194 | 194 | } |
| 195 | 195 | |
| 196 | - /** |
|
| 197 | - * Retrieve field label class |
|
| 198 | - * @return string |
|
| 199 | - */ |
|
| 200 | - function get_label_class() { |
|
| 201 | - return 'gv-label-'. sanitize_html_class( $this->field['type'] ); |
|
| 202 | - } |
|
| 203 | - |
|
| 204 | - |
|
| 205 | - /** |
|
| 206 | - * Retrieve field description |
|
| 207 | - * @return string |
|
| 208 | - */ |
|
| 209 | - function get_field_desc() { |
|
| 210 | - return !empty( $this->field['desc'] ) ? '<span class="howto">'. $this->field['desc'] .'</span>' : ''; |
|
| 211 | - } |
|
| 212 | - |
|
| 213 | - |
|
| 214 | - /** |
|
| 215 | - * Verify if field should have merge tags |
|
| 216 | - * @return boolean |
|
| 217 | - */ |
|
| 218 | - function show_merge_tags() { |
|
| 219 | - // Show the merge tags if the field is a list view |
|
| 220 | - $is_list = preg_match( '/_list-/ism', $this->name ); |
|
| 221 | - // Or is a single entry view |
|
| 222 | - $is_single = preg_match( '/single_/ism', $this->name ); |
|
| 223 | - |
|
| 224 | - return ( $is_single || $is_list ); |
|
| 225 | - } |
|
| 226 | - |
|
| 227 | - |
|
| 228 | - |
|
| 229 | - /** |
|
| 230 | - * important! Override this class |
|
| 231 | - * outputs the field option html |
|
| 232 | - */ |
|
| 233 | - function render_option() { |
|
| 234 | - // to replace on each field |
|
| 235 | - } |
|
| 236 | - |
|
| 237 | - /** |
|
| 238 | - * important! Override this class if needed |
|
| 239 | - * outputs the field setting html |
|
| 240 | - */ |
|
| 241 | - function render_setting( $override_input = NULL ) { |
|
| 242 | - |
|
| 243 | - if( !empty( $this->field['full_width'] ) ) { ?> |
|
| 196 | + /** |
|
| 197 | + * Retrieve field label class |
|
| 198 | + * @return string |
|
| 199 | + */ |
|
| 200 | + function get_label_class() { |
|
| 201 | + return 'gv-label-'. sanitize_html_class( $this->field['type'] ); |
|
| 202 | + } |
|
| 203 | + |
|
| 204 | + |
|
| 205 | + /** |
|
| 206 | + * Retrieve field description |
|
| 207 | + * @return string |
|
| 208 | + */ |
|
| 209 | + function get_field_desc() { |
|
| 210 | + return !empty( $this->field['desc'] ) ? '<span class="howto">'. $this->field['desc'] .'</span>' : ''; |
|
| 211 | + } |
|
| 212 | + |
|
| 213 | + |
|
| 214 | + /** |
|
| 215 | + * Verify if field should have merge tags |
|
| 216 | + * @return boolean |
|
| 217 | + */ |
|
| 218 | + function show_merge_tags() { |
|
| 219 | + // Show the merge tags if the field is a list view |
|
| 220 | + $is_list = preg_match( '/_list-/ism', $this->name ); |
|
| 221 | + // Or is a single entry view |
|
| 222 | + $is_single = preg_match( '/single_/ism', $this->name ); |
|
| 223 | + |
|
| 224 | + return ( $is_single || $is_list ); |
|
| 225 | + } |
|
| 226 | + |
|
| 227 | + |
|
| 228 | + |
|
| 229 | + /** |
|
| 230 | + * important! Override this class |
|
| 231 | + * outputs the field option html |
|
| 232 | + */ |
|
| 233 | + function render_option() { |
|
| 234 | + // to replace on each field |
|
| 235 | + } |
|
| 236 | + |
|
| 237 | + /** |
|
| 238 | + * important! Override this class if needed |
|
| 239 | + * outputs the field setting html |
|
| 240 | + */ |
|
| 241 | + function render_setting( $override_input = NULL ) { |
|
| 242 | + |
|
| 243 | + if( !empty( $this->field['full_width'] ) ) { ?> |
|
| 244 | 244 | <th scope="row" colspan="2"> |
| 245 | 245 | <div> |
| 246 | 246 | <label for="<?php echo $this->get_field_id(); ?>"> |
@@ -260,14 +260,14 @@ discard block |
||
| 260 | 260 | </td> |
| 261 | 261 | <?php } |
| 262 | 262 | |
| 263 | - } |
|
| 263 | + } |
|
| 264 | 264 | |
| 265 | - /** |
|
| 266 | - * important! Override this class |
|
| 267 | - * outputs the input html part |
|
| 268 | - */ |
|
| 269 | - function render_input( $override_input ) { |
|
| 270 | - echo ''; |
|
| 271 | - } |
|
| 265 | + /** |
|
| 266 | + * important! Override this class |
|
| 267 | + * outputs the input html part |
|
| 268 | + */ |
|
| 269 | + function render_input( $override_input ) { |
|
| 270 | + echo ''; |
|
| 271 | + } |
|
| 272 | 272 | |
| 273 | 273 | } |
@@ -532,7 +532,7 @@ |
||
| 532 | 532 | * @since 1.16.4 |
| 533 | 533 | * @param int $entry_id ID of the Gravity Forms entry |
| 534 | 534 | * @param array $entry Deleted entry array |
| 535 | - */ |
|
| 535 | + */ |
|
| 536 | 536 | do_action( 'gravityview/delete-entry/deleted', $entry_id, $entry ); |
| 537 | 537 | } |
| 538 | 538 | |
@@ -270,7 +270,7 @@ discard block |
||
| 270 | 270 | * |
| 271 | 271 | * Verify permissions. Check expected $_POST. Parse args, then send to process_delete_notes |
| 272 | 272 | * |
| 273 | - * @since 1.17 |
|
| 273 | + * @since 1.17 |
|
| 274 | 274 | * |
| 275 | 275 | * @see process_delete_notes |
| 276 | 276 | * |
@@ -423,7 +423,7 @@ discard block |
||
| 423 | 423 | 'subject-label' => __( 'Subject', 'gravityview' ), |
| 424 | 424 | 'subject' => __( 'Email subject', 'gravityview' ), |
| 425 | 425 | 'default-email-subject' => __( 'New entry note', 'gravityview' ), |
| 426 | - 'email-footer' => __( 'This note was sent from {url}', 'gravityview' ), |
|
| 426 | + 'email-footer' => __( 'This note was sent from {url}', 'gravityview' ), |
|
| 427 | 427 | 'also-email' => __( 'Also email this note to', 'gravityview' ), |
| 428 | 428 | 'error-add-note' => __( 'There was an error adding the note.', 'gravityview' ), |
| 429 | 429 | 'error-invalid' => __( 'The request was invalid. Refresh the page and try again.', 'gravityview' ), |
@@ -493,11 +493,11 @@ discard block |
||
| 493 | 493 | |
| 494 | 494 | if ( $context instanceof \GV\Template_Context ) { |
| 495 | 495 | |
| 496 | - ob_start(); |
|
| 497 | - $context->template->get_template_part( 'note', 'detail', true ); |
|
| 498 | - $note_detail_html = ob_get_clean(); |
|
| 496 | + ob_start(); |
|
| 497 | + $context->template->get_template_part( 'note', 'detail', true ); |
|
| 498 | + $note_detail_html = ob_get_clean(); |
|
| 499 | 499 | |
| 500 | - ob_start(); |
|
| 500 | + ob_start(); |
|
| 501 | 501 | $context->template->get_template_part( 'note', $note_row_template, true ); |
| 502 | 502 | $note_row = ob_get_clean(); |
| 503 | 503 | } else { |
@@ -756,7 +756,7 @@ discard block |
||
| 756 | 756 | 'gv-note-to-custom' => '', |
| 757 | 757 | 'gv-note-subject' => '', |
| 758 | 758 | 'gv-note-content' => '', |
| 759 | - 'current-url' => '', |
|
| 759 | + 'current-url' => '', |
|
| 760 | 760 | ); |
| 761 | 761 | |
| 762 | 762 | $current_user = wp_get_current_user(); |
@@ -808,9 +808,9 @@ discard block |
||
| 808 | 808 | $message .= $this->get_email_footer( $email_footer, $is_html, $email_data ); |
| 809 | 809 | |
| 810 | 810 | /** |
| 811 | - * @filter `gravityview/field/notes/wpautop_email` Should the message content have paragraphs added automatically, if using HTML message format |
|
| 811 | + * @filter `gravityview/field/notes/wpautop_email` Should the message content have paragraphs added automatically, if using HTML message format |
|
| 812 | 812 | * @since 1.18 |
| 813 | - * @param bool $wpautop_email True: Apply wpautop() to the email message if using; False: Leave as entered (Default: true) |
|
| 813 | + * @param bool $wpautop_email True: Apply wpautop() to the email message if using; False: Leave as entered (Default: true) |
|
| 814 | 814 | */ |
| 815 | 815 | $wpautop_email = apply_filters( 'gravityview/field/notes/wpautop_email', true ); |
| 816 | 816 | |
@@ -830,12 +830,12 @@ discard block |
||
| 830 | 830 | } |
| 831 | 831 | |
| 832 | 832 | /** |
| 833 | - * Get the footer for Entry Note emails |
|
| 834 | - * |
|
| 835 | - * `{url}` is replaced by the URL of the page where the note form was embedded |
|
| 836 | - * |
|
| 837 | - * @since 1.18 |
|
| 838 | - * @see GravityView_Field_Notes::strings The default value of $message_footer is set here, with the key 'email-footer' |
|
| 833 | + * Get the footer for Entry Note emails |
|
| 834 | + * |
|
| 835 | + * `{url}` is replaced by the URL of the page where the note form was embedded |
|
| 836 | + * |
|
| 837 | + * @since 1.18 |
|
| 838 | + * @see GravityView_Field_Notes::strings The default value of $message_footer is set here, with the key 'email-footer' |
|
| 839 | 839 | * |
| 840 | 840 | * @param string $email_footer The message footer value |
| 841 | 841 | * @param bool $is_html True: Email is being sent as HTML; False: sent as text |
@@ -844,10 +844,10 @@ discard block |
||
| 844 | 844 | */ |
| 845 | 845 | private function get_email_footer( $email_footer = '', $is_html = true, $email_data = array() ) { |
| 846 | 846 | |
| 847 | - $output = ''; |
|
| 847 | + $output = ''; |
|
| 848 | 848 | |
| 849 | 849 | if( ! empty( $email_footer ) ) { |
| 850 | - $url = \GV\Utils::get( $email_data, 'current-url' ); |
|
| 850 | + $url = \GV\Utils::get( $email_data, 'current-url' ); |
|
| 851 | 851 | $url = html_entity_decode( $url ); |
| 852 | 852 | $url = site_url( $url ); |
| 853 | 853 | |
@@ -240,7 +240,7 @@ |
||
| 240 | 240 | self::$notices['wp_version'] = array( |
| 241 | 241 | 'class' => 'error', |
| 242 | 242 | 'message' => sprintf( __( "%sGravityView requires WordPress %s or newer.%s \n\nYou're using Version %s. Please upgrade your WordPress installation.", 'gravityview' ), '<h3>', GV_MIN_WP_VERSION, "</h3>\n\n", '<span style="font-family: Consolas, Courier, monospace;">' . $wp_version . '</span>' ), |
| 243 | - 'cap' => 'update_core', |
|
| 243 | + 'cap' => 'update_core', |
|
| 244 | 244 | 'dismiss' => 'wp_version', |
| 245 | 245 | ); |
| 246 | 246 | |
@@ -28,13 +28,13 @@ discard block |
||
| 28 | 28 | |
| 29 | 29 | $show_mt = $this->show_merge_tags(); |
| 30 | 30 | |
| 31 | - if( $show_mt && $this->field['merge_tags'] !== false || $this->field['merge_tags'] === 'force' ) { |
|
| 32 | - $class .= ' merge-tag-support mt-position-right '; |
|
| 31 | + if( $show_mt && $this->field['merge_tags'] !== false || $this->field['merge_tags'] === 'force' ) { |
|
| 32 | + $class .= ' merge-tag-support mt-position-right '; |
|
| 33 | 33 | |
| 34 | - if( empty( $this->field['show_all_fields'] ) ) { |
|
| 35 | - $class .= ' mt-hide_all_fields '; |
|
| 36 | - } |
|
| 37 | - } |
|
| 34 | + if( empty( $this->field['show_all_fields'] ) ) { |
|
| 35 | + $class .= ' mt-hide_all_fields '; |
|
| 36 | + } |
|
| 37 | + } |
|
| 38 | 38 | |
| 39 | 39 | $class .= rgar( $this->field, 'class' ); |
| 40 | 40 | $placeholder = rgar( $this->field, 'placeholder' ); |
@@ -55,20 +55,20 @@ discard block |
||
| 55 | 55 | |
| 56 | 56 | function codemirror( $field_id = '' ) { |
| 57 | 57 | |
| 58 | - // Enqueue code editor and settings for manipulating HTML. |
|
| 59 | - $settings = wp_enqueue_code_editor( array( 'type' => 'text/html' ) ); |
|
| 58 | + // Enqueue code editor and settings for manipulating HTML. |
|
| 59 | + $settings = wp_enqueue_code_editor( array( 'type' => 'text/html' ) ); |
|
| 60 | 60 | |
| 61 | - // Bail if user disabled CodeMirror. |
|
| 62 | - if ( false === $settings ) { |
|
| 63 | - return; |
|
| 64 | - } |
|
| 61 | + // Bail if user disabled CodeMirror. |
|
| 62 | + if ( false === $settings ) { |
|
| 63 | + return; |
|
| 64 | + } |
|
| 65 | 65 | |
| 66 | - ?> |
|
| 66 | + ?> |
|
| 67 | 67 | |
| 68 | 68 | <script> |
| 69 | 69 | wp.codeEditor.initialize( "<?php echo $field_id;?>", {}); |
| 70 | 70 | </script> |
| 71 | 71 | <?php |
| 72 | - } |
|
| 72 | + } |
|
| 73 | 73 | |
| 74 | 74 | } |
@@ -18,84 +18,84 @@ discard block |
||
| 18 | 18 | |
| 19 | 19 | class GravityView_Edit_Entry { |
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * @var string |
|
| 23 | - */ |
|
| 21 | + /** |
|
| 22 | + * @var string |
|
| 23 | + */ |
|
| 24 | 24 | static $file; |
| 25 | 25 | |
| 26 | 26 | static $instance; |
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * Component instances. |
|
| 30 | - * @var array |
|
| 31 | - */ |
|
| 32 | - public $instances = array(); |
|
| 28 | + /** |
|
| 29 | + * Component instances. |
|
| 30 | + * @var array |
|
| 31 | + */ |
|
| 32 | + public $instances = array(); |
|
| 33 | 33 | |
| 34 | 34 | |
| 35 | 35 | function __construct() { |
| 36 | 36 | |
| 37 | - self::$file = plugin_dir_path( __FILE__ ); |
|
| 37 | + self::$file = plugin_dir_path( __FILE__ ); |
|
| 38 | 38 | |
| 39 | - if( is_admin() ) { |
|
| 40 | - $this->load_components( 'admin' ); |
|
| 41 | - } |
|
| 39 | + if( is_admin() ) { |
|
| 40 | + $this->load_components( 'admin' ); |
|
| 41 | + } |
|
| 42 | 42 | |
| 43 | 43 | $this->load_components( 'locking' ); |
| 44 | 44 | |
| 45 | - $this->load_components( 'render' ); |
|
| 45 | + $this->load_components( 'render' ); |
|
| 46 | 46 | |
| 47 | - // If GF User Registration Add-on exists |
|
| 48 | - $this->load_components( 'user-registration' ); |
|
| 47 | + // If GF User Registration Add-on exists |
|
| 48 | + $this->load_components( 'user-registration' ); |
|
| 49 | 49 | |
| 50 | - $this->add_hooks(); |
|
| 50 | + $this->add_hooks(); |
|
| 51 | 51 | |
| 52 | 52 | // Process hooks for addons that may or may not be present |
| 53 | 53 | $this->addon_specific_hooks(); |
| 54 | 54 | } |
| 55 | 55 | |
| 56 | 56 | |
| 57 | - static function getInstance() { |
|
| 57 | + static function getInstance() { |
|
| 58 | 58 | |
| 59 | - if( empty( self::$instance ) ) { |
|
| 60 | - self::$instance = new GravityView_Edit_Entry; |
|
| 61 | - } |
|
| 59 | + if( empty( self::$instance ) ) { |
|
| 60 | + self::$instance = new GravityView_Edit_Entry; |
|
| 61 | + } |
|
| 62 | 62 | |
| 63 | - return self::$instance; |
|
| 64 | - } |
|
| 63 | + return self::$instance; |
|
| 64 | + } |
|
| 65 | 65 | |
| 66 | 66 | |
| 67 | - private function load_components( $component ) { |
|
| 67 | + private function load_components( $component ) { |
|
| 68 | 68 | |
| 69 | - $dir = trailingslashit( self::$file ); |
|
| 69 | + $dir = trailingslashit( self::$file ); |
|
| 70 | 70 | |
| 71 | - $filename = $dir . 'class-edit-entry-' . $component . '.php'; |
|
| 72 | - $classname = 'GravityView_Edit_Entry_' . str_replace( ' ', '_', ucwords( str_replace( '-', ' ', $component ) ) ); |
|
| 71 | + $filename = $dir . 'class-edit-entry-' . $component . '.php'; |
|
| 72 | + $classname = 'GravityView_Edit_Entry_' . str_replace( ' ', '_', ucwords( str_replace( '-', ' ', $component ) ) ); |
|
| 73 | 73 | |
| 74 | - // Loads component and pass extension's instance so that component can |
|
| 75 | - // talk each other. |
|
| 76 | - require_once $filename; |
|
| 77 | - $this->instances[ $component ] = new $classname( $this ); |
|
| 78 | - $this->instances[ $component ]->load(); |
|
| 74 | + // Loads component and pass extension's instance so that component can |
|
| 75 | + // talk each other. |
|
| 76 | + require_once $filename; |
|
| 77 | + $this->instances[ $component ] = new $classname( $this ); |
|
| 78 | + $this->instances[ $component ]->load(); |
|
| 79 | 79 | |
| 80 | - } |
|
| 80 | + } |
|
| 81 | 81 | |
| 82 | - private function add_hooks() { |
|
| 82 | + private function add_hooks() { |
|
| 83 | 83 | |
| 84 | - // Add front-end access to Gravity Forms delete file action |
|
| 85 | - add_action( 'wp_ajax_nopriv_rg_delete_file', array( 'GFForms', 'delete_file') ); |
|
| 84 | + // Add front-end access to Gravity Forms delete file action |
|
| 85 | + add_action( 'wp_ajax_nopriv_rg_delete_file', array( 'GFForms', 'delete_file') ); |
|
| 86 | 86 | |
| 87 | - // Make sure this hook is run for non-admins |
|
| 88 | - add_action( 'wp_ajax_rg_delete_file', array( 'GFForms', 'delete_file') ); |
|
| 87 | + // Make sure this hook is run for non-admins |
|
| 88 | + add_action( 'wp_ajax_rg_delete_file', array( 'GFForms', 'delete_file') ); |
|
| 89 | 89 | |
| 90 | - add_filter( 'gravityview_blacklist_field_types', array( $this, 'modify_field_blacklist' ), 10, 2 ); |
|
| 90 | + add_filter( 'gravityview_blacklist_field_types', array( $this, 'modify_field_blacklist' ), 10, 2 ); |
|
| 91 | 91 | |
| 92 | - // add template path to check for field |
|
| 93 | - add_filter( 'gravityview_template_paths', array( $this, 'add_template_path' ) ); |
|
| 92 | + // add template path to check for field |
|
| 93 | + add_filter( 'gravityview_template_paths', array( $this, 'add_template_path' ) ); |
|
| 94 | 94 | |
| 95 | 95 | add_filter( 'gravityview/field/is_visible', array( $this, 'maybe_not_visible' ), 10, 3 ); |
| 96 | 96 | |
| 97 | 97 | add_filter( 'gravityview/api/reserved_query_args', array( $this, 'add_reserved_arg' ) ); |
| 98 | - } |
|
| 98 | + } |
|
| 99 | 99 | |
| 100 | 100 | /** |
| 101 | 101 | * Adds "edit" to the list of internal reserved query args |
@@ -166,74 +166,74 @@ discard block |
||
| 166 | 166 | return false; |
| 167 | 167 | } |
| 168 | 168 | |
| 169 | - /** |
|
| 170 | - * Include this extension templates path |
|
| 171 | - * @param array $file_paths List of template paths ordered |
|
| 172 | - */ |
|
| 173 | - public function add_template_path( $file_paths ) { |
|
| 174 | - |
|
| 175 | - // Index 100 is the default GravityView template path. |
|
| 176 | - $file_paths[ 110 ] = self::$file; |
|
| 177 | - |
|
| 178 | - return $file_paths; |
|
| 179 | - } |
|
| 180 | - |
|
| 181 | - /** |
|
| 182 | - * |
|
| 183 | - * Return a well formatted nonce key according to GravityView Edit Entry protocol |
|
| 184 | - * |
|
| 185 | - * @param $view_id int GravityView view id |
|
| 186 | - * @param $form_id int Gravity Forms form id |
|
| 187 | - * @param $entry_id int Gravity Forms entry id |
|
| 188 | - * @return string |
|
| 189 | - */ |
|
| 190 | - public static function get_nonce_key( $view_id, $form_id, $entry_id ) { |
|
| 191 | - return sprintf( 'edit_%d_%d_%d', $view_id, $form_id, $entry_id ); |
|
| 192 | - } |
|
| 193 | - |
|
| 194 | - |
|
| 195 | - /** |
|
| 196 | - * The edit entry link creates a secure link with a nonce |
|
| 197 | - * |
|
| 198 | - * It also mimics the URL structure Gravity Forms expects to have so that |
|
| 199 | - * it formats the display of the edit form like it does in the backend, like |
|
| 200 | - * "You can edit this post from the post page" fields, for example. |
|
| 201 | - * |
|
| 202 | - * @param $entry array Gravity Forms entry object |
|
| 203 | - * @param $view_id int GravityView view id |
|
| 204 | - * @param $post_id int GravityView Post ID where View may be embedded {@since 1.9.2} |
|
| 205 | - * @param string|array $field_values Parameters to pass in to the Edit Entry form to prefill data. Uses the same format as Gravity Forms "Allow field to be populated dynamically" {@since 1.9.2} {@see https://www.gravityhelp.com/documentation/article/allow-field-to-be-populated-dynamically/ } |
|
| 206 | - * @return string |
|
| 207 | - */ |
|
| 208 | - public static function get_edit_link( $entry, $view_id, $post_id = null, $field_values = '' ) { |
|
| 209 | - |
|
| 210 | - $nonce_key = self::get_nonce_key( $view_id, $entry['form_id'], $entry['id'] ); |
|
| 211 | - |
|
| 212 | - $base = gv_entry_link( $entry, $post_id ? : $view_id ); |
|
| 213 | - |
|
| 214 | - $url = add_query_arg( array( |
|
| 215 | - 'edit' => wp_create_nonce( $nonce_key ) |
|
| 216 | - ), $base ); |
|
| 217 | - |
|
| 218 | - if( $post_id ) { |
|
| 219 | - $url = add_query_arg( array( 'gvid' => $view_id ), $url ); |
|
| 220 | - } |
|
| 221 | - |
|
| 222 | - /** |
|
| 223 | - * Allow passing params to dynamically populate entry with values |
|
| 224 | - * @since 1.9.2 |
|
| 225 | - */ |
|
| 226 | - if( !empty( $field_values ) ) { |
|
| 227 | - |
|
| 228 | - if( is_array( $field_values ) ) { |
|
| 229 | - // If already an array, no parse_str() needed |
|
| 230 | - $params = $field_values; |
|
| 231 | - } else { |
|
| 232 | - parse_str( $field_values, $params ); |
|
| 233 | - } |
|
| 234 | - |
|
| 235 | - $url = add_query_arg( $params, $url ); |
|
| 236 | - } |
|
| 169 | + /** |
|
| 170 | + * Include this extension templates path |
|
| 171 | + * @param array $file_paths List of template paths ordered |
|
| 172 | + */ |
|
| 173 | + public function add_template_path( $file_paths ) { |
|
| 174 | + |
|
| 175 | + // Index 100 is the default GravityView template path. |
|
| 176 | + $file_paths[ 110 ] = self::$file; |
|
| 177 | + |
|
| 178 | + return $file_paths; |
|
| 179 | + } |
|
| 180 | + |
|
| 181 | + /** |
|
| 182 | + * |
|
| 183 | + * Return a well formatted nonce key according to GravityView Edit Entry protocol |
|
| 184 | + * |
|
| 185 | + * @param $view_id int GravityView view id |
|
| 186 | + * @param $form_id int Gravity Forms form id |
|
| 187 | + * @param $entry_id int Gravity Forms entry id |
|
| 188 | + * @return string |
|
| 189 | + */ |
|
| 190 | + public static function get_nonce_key( $view_id, $form_id, $entry_id ) { |
|
| 191 | + return sprintf( 'edit_%d_%d_%d', $view_id, $form_id, $entry_id ); |
|
| 192 | + } |
|
| 193 | + |
|
| 194 | + |
|
| 195 | + /** |
|
| 196 | + * The edit entry link creates a secure link with a nonce |
|
| 197 | + * |
|
| 198 | + * It also mimics the URL structure Gravity Forms expects to have so that |
|
| 199 | + * it formats the display of the edit form like it does in the backend, like |
|
| 200 | + * "You can edit this post from the post page" fields, for example. |
|
| 201 | + * |
|
| 202 | + * @param $entry array Gravity Forms entry object |
|
| 203 | + * @param $view_id int GravityView view id |
|
| 204 | + * @param $post_id int GravityView Post ID where View may be embedded {@since 1.9.2} |
|
| 205 | + * @param string|array $field_values Parameters to pass in to the Edit Entry form to prefill data. Uses the same format as Gravity Forms "Allow field to be populated dynamically" {@since 1.9.2} {@see https://www.gravityhelp.com/documentation/article/allow-field-to-be-populated-dynamically/ } |
|
| 206 | + * @return string |
|
| 207 | + */ |
|
| 208 | + public static function get_edit_link( $entry, $view_id, $post_id = null, $field_values = '' ) { |
|
| 209 | + |
|
| 210 | + $nonce_key = self::get_nonce_key( $view_id, $entry['form_id'], $entry['id'] ); |
|
| 211 | + |
|
| 212 | + $base = gv_entry_link( $entry, $post_id ? : $view_id ); |
|
| 213 | + |
|
| 214 | + $url = add_query_arg( array( |
|
| 215 | + 'edit' => wp_create_nonce( $nonce_key ) |
|
| 216 | + ), $base ); |
|
| 217 | + |
|
| 218 | + if( $post_id ) { |
|
| 219 | + $url = add_query_arg( array( 'gvid' => $view_id ), $url ); |
|
| 220 | + } |
|
| 221 | + |
|
| 222 | + /** |
|
| 223 | + * Allow passing params to dynamically populate entry with values |
|
| 224 | + * @since 1.9.2 |
|
| 225 | + */ |
|
| 226 | + if( !empty( $field_values ) ) { |
|
| 227 | + |
|
| 228 | + if( is_array( $field_values ) ) { |
|
| 229 | + // If already an array, no parse_str() needed |
|
| 230 | + $params = $field_values; |
|
| 231 | + } else { |
|
| 232 | + parse_str( $field_values, $params ); |
|
| 233 | + } |
|
| 234 | + |
|
| 235 | + $url = add_query_arg( $params, $url ); |
|
| 236 | + } |
|
| 237 | 237 | |
| 238 | 238 | /** |
| 239 | 239 | * @filter `gravityview/edit/link` Filter the edit URL link. |
@@ -242,7 +242,7 @@ discard block |
||
| 242 | 242 | * @param \GV\View $view The View. |
| 243 | 243 | */ |
| 244 | 244 | return apply_filters( 'gravityview/edit/link', $url, $entry, \GV\View::by_id( $view_id ) ); |
| 245 | - } |
|
| 245 | + } |
|
| 246 | 246 | |
| 247 | 247 | /** |
| 248 | 248 | * Edit mode doesn't allow certain field types. |
@@ -297,19 +297,19 @@ discard block |
||
| 297 | 297 | } |
| 298 | 298 | |
| 299 | 299 | |
| 300 | - /** |
|
| 301 | - * checks if user has permissions to edit a specific entry |
|
| 302 | - * |
|
| 303 | - * Needs to be used combined with GravityView_Edit_Entry::user_can_edit_entry for maximum security!! |
|
| 304 | - * |
|
| 305 | - * @param array $entry Gravity Forms entry array |
|
| 306 | - * @param \GV\View|int $view ID of the view you want to check visibility against {@since 1.9.2}. Required since 2.0 |
|
| 307 | - * @return bool |
|
| 308 | - */ |
|
| 309 | - public static function check_user_cap_edit_entry( $entry, $view = 0 ) { |
|
| 300 | + /** |
|
| 301 | + * checks if user has permissions to edit a specific entry |
|
| 302 | + * |
|
| 303 | + * Needs to be used combined with GravityView_Edit_Entry::user_can_edit_entry for maximum security!! |
|
| 304 | + * |
|
| 305 | + * @param array $entry Gravity Forms entry array |
|
| 306 | + * @param \GV\View|int $view ID of the view you want to check visibility against {@since 1.9.2}. Required since 2.0 |
|
| 307 | + * @return bool |
|
| 308 | + */ |
|
| 309 | + public static function check_user_cap_edit_entry( $entry, $view = 0 ) { |
|
| 310 | 310 | |
| 311 | - // No permission by default |
|
| 312 | - $user_can_edit = false; |
|
| 311 | + // No permission by default |
|
| 312 | + $user_can_edit = false; |
|
| 313 | 313 | |
| 314 | 314 | // get user_edit setting |
| 315 | 315 | if ( empty( $view ) ) { |
@@ -327,60 +327,60 @@ discard block |
||
| 327 | 327 | $user_edit = GVCommon::get_template_setting( $view_id, 'user_edit' ); |
| 328 | 328 | } |
| 329 | 329 | |
| 330 | - // If they can edit any entries (as defined in Gravity Forms) |
|
| 331 | - // Or if they can edit other people's entries |
|
| 332 | - // Then we're good. |
|
| 333 | - if( GVCommon::has_cap( array( 'gravityforms_edit_entries', 'gravityview_edit_others_entries' ), $entry['id'] ) ) { |
|
| 330 | + // If they can edit any entries (as defined in Gravity Forms) |
|
| 331 | + // Or if they can edit other people's entries |
|
| 332 | + // Then we're good. |
|
| 333 | + if( GVCommon::has_cap( array( 'gravityforms_edit_entries', 'gravityview_edit_others_entries' ), $entry['id'] ) ) { |
|
| 334 | 334 | |
| 335 | - gravityview()->log->debug( 'User has ability to edit all entries.' ); |
|
| 335 | + gravityview()->log->debug( 'User has ability to edit all entries.' ); |
|
| 336 | 336 | |
| 337 | - $user_can_edit = true; |
|
| 337 | + $user_can_edit = true; |
|
| 338 | 338 | |
| 339 | - } else if( !isset( $entry['created_by'] ) ) { |
|
| 339 | + } else if( !isset( $entry['created_by'] ) ) { |
|
| 340 | 340 | |
| 341 | - gravityview()->log->error( 'Entry `created_by` doesn\'t exist.'); |
|
| 341 | + gravityview()->log->error( 'Entry `created_by` doesn\'t exist.'); |
|
| 342 | 342 | |
| 343 | - $user_can_edit = false; |
|
| 343 | + $user_can_edit = false; |
|
| 344 | 344 | |
| 345 | - } else { |
|
| 345 | + } else { |
|
| 346 | 346 | |
| 347 | - $current_user = wp_get_current_user(); |
|
| 347 | + $current_user = wp_get_current_user(); |
|
| 348 | 348 | |
| 349 | - // User edit is disabled |
|
| 350 | - if( empty( $user_edit ) ) { |
|
| 349 | + // User edit is disabled |
|
| 350 | + if( empty( $user_edit ) ) { |
|
| 351 | 351 | |
| 352 | - gravityview()->log->debug( 'User Edit is disabled. Returning false.' ); |
|
| 352 | + gravityview()->log->debug( 'User Edit is disabled. Returning false.' ); |
|
| 353 | 353 | |
| 354 | - $user_can_edit = false; |
|
| 355 | - } |
|
| 354 | + $user_can_edit = false; |
|
| 355 | + } |
|
| 356 | 356 | |
| 357 | - // User edit is enabled and the logged-in user is the same as the user who created the entry. We're good. |
|
| 358 | - else if( is_user_logged_in() && intval( $current_user->ID ) === intval( $entry['created_by'] ) ) { |
|
| 357 | + // User edit is enabled and the logged-in user is the same as the user who created the entry. We're good. |
|
| 358 | + else if( is_user_logged_in() && intval( $current_user->ID ) === intval( $entry['created_by'] ) ) { |
|
| 359 | 359 | |
| 360 | - gravityview()->log->debug( 'User {user_id} created the entry.', array( 'user_id', $current_user->ID ) ); |
|
| 360 | + gravityview()->log->debug( 'User {user_id} created the entry.', array( 'user_id', $current_user->ID ) ); |
|
| 361 | 361 | |
| 362 | - $user_can_edit = true; |
|
| 362 | + $user_can_edit = true; |
|
| 363 | 363 | |
| 364 | - } else if( ! is_user_logged_in() ) { |
|
| 364 | + } else if( ! is_user_logged_in() ) { |
|
| 365 | 365 | |
| 366 | - gravityview()->log->debug( 'No user defined; edit entry requires logged in user' ); |
|
| 366 | + gravityview()->log->debug( 'No user defined; edit entry requires logged in user' ); |
|
| 367 | 367 | |
| 368 | - $user_can_edit = false; // Here just for clarity |
|
| 369 | - } |
|
| 368 | + $user_can_edit = false; // Here just for clarity |
|
| 369 | + } |
|
| 370 | 370 | |
| 371 | - } |
|
| 371 | + } |
|
| 372 | 372 | |
| 373 | - /** |
|
| 374 | - * @filter `gravityview/edit_entry/user_can_edit_entry` Modify whether user can edit an entry. |
|
| 375 | - * @since 1.15 Added `$entry` and `$view_id` parameters |
|
| 376 | - * @param[in,out] boolean $user_can_edit Can the current user edit the current entry? (Default: false) |
|
| 377 | - * @param[in] array $entry Gravity Forms entry array {@since 1.15} |
|
| 378 | - * @param[in] int $view_id ID of the view you want to check visibility against {@since 1.15} |
|
| 379 | - */ |
|
| 380 | - $user_can_edit = apply_filters( 'gravityview/edit_entry/user_can_edit_entry', $user_can_edit, $entry, $view_id ); |
|
| 373 | + /** |
|
| 374 | + * @filter `gravityview/edit_entry/user_can_edit_entry` Modify whether user can edit an entry. |
|
| 375 | + * @since 1.15 Added `$entry` and `$view_id` parameters |
|
| 376 | + * @param[in,out] boolean $user_can_edit Can the current user edit the current entry? (Default: false) |
|
| 377 | + * @param[in] array $entry Gravity Forms entry array {@since 1.15} |
|
| 378 | + * @param[in] int $view_id ID of the view you want to check visibility against {@since 1.15} |
|
| 379 | + */ |
|
| 380 | + $user_can_edit = apply_filters( 'gravityview/edit_entry/user_can_edit_entry', $user_can_edit, $entry, $view_id ); |
|
| 381 | 381 | |
| 382 | - return (bool) $user_can_edit; |
|
| 383 | - } |
|
| 382 | + return (bool) $user_can_edit; |
|
| 383 | + } |
|
| 384 | 384 | |
| 385 | 385 | |
| 386 | 386 | |
@@ -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,109 +22,109 @@ discard block |
||
| 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 |
||
| 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 |
@@ -284,7 +284,7 @@ |
||
| 284 | 284 | <div class="gv-field-detail gv-field-detail--field"> |
| 285 | 285 | <span class="gv-field-detail--label">' . esc_html__( 'Field ID', 'gravityview' ) .'</span><span class="gv-field-detail--value">#{{field_id}}</span> |
| 286 | 286 | </div>'; |
| 287 | - } |
|
| 287 | + } |
|
| 288 | 288 | |
| 289 | 289 | $item_details .= ' |
| 290 | 290 | <div class="gv-field-detail gv-field-detail--type"> |
@@ -45,13 +45,13 @@ |
||
| 45 | 45 | } |
| 46 | 46 | |
| 47 | 47 | $field_options['link_phone'] = array( |
| 48 | - 'type' => 'checkbox', |
|
| 49 | - 'label' => __( 'Make Phone Number Clickable', 'gravityview' ), |
|
| 50 | - 'desc' => __( 'Allow dialing a number by clicking it?', 'gravityview'), |
|
| 51 | - 'value' => true, |
|
| 52 | - 'group' => 'display', |
|
| 53 | - 'priority' => 100, |
|
| 54 | - ); |
|
| 48 | + 'type' => 'checkbox', |
|
| 49 | + 'label' => __( 'Make Phone Number Clickable', 'gravityview' ), |
|
| 50 | + 'desc' => __( 'Allow dialing a number by clicking it?', 'gravityview'), |
|
| 51 | + 'value' => true, |
|
| 52 | + 'group' => 'display', |
|
| 53 | + 'priority' => 100, |
|
| 54 | + ); |
|
| 55 | 55 | |
| 56 | 56 | return $field_options; |
| 57 | 57 | } |