name = $this->is_editable() ? esc_html__( 'Internal Information', 'wpforms-lite' ) : esc_html__( 'This field is not editable', 'wpforms-lite' ); $this->type = 'internal-information'; $this->icon = 'fa fa-sticky-note-o'; $this->order = 550; $this->hooks(); } /** * Register hooks. * * @since 1.7.6 * * @noinspection PhpUnnecessaryCurlyVarSyntaxInspection */ private function hooks() { add_filter( 'wpforms_entries_table_fields_disallow', [ $this, 'hide_column_in_entries_table' ], 10, 2 ); add_filter( 'wpforms_field_preview_class', [ $this, 'add_css_class_for_field_wrapper' ], 10, 2 ); add_filter( 'wpforms_field_new_class', [ $this, 'add_css_class_for_field_wrapper' ], 10, 2 ); add_filter( "wpforms_pro_admin_entries_edit_is_field_displayable_{$this->type}", '__return_false' ); add_filter( 'wpforms_builder_strings', [ $this, 'builder_strings' ], 10, 2 ); add_filter( 'wpforms_frontend_form_data', [ $this, 'remove_internal_fields_on_front_end' ], 10, 1 ); add_filter( 'wpforms_process_before_form_data', [ $this, 'process_before_form_data' ], 10, 2 ); add_filter( 'wpforms_field_preview_display_duplicate_button', [ $this, 'display_duplicate_button' ], 10, 3 ); add_action( 'wpforms_builder_enqueues', [ $this, 'builder_enqueues' ] ); add_action( 'wp_ajax_wpforms_builder_save_internal_information_checkbox', [ $this, 'save_internal_information_checkbox' ] ); } /** * Whether current field can be populated dynamically. * * @since 1.7.6 * * @param array $properties Field properties. * @param array $field Current field specific data. * * @return bool */ public function is_dynamic_population_allowed( $properties, $field ) { return false; } /** * Whether current field can be populated using a fallback. * * @since 1.7.6 * * @param array $properties Field properties. * @param array $field Current field specific data. * * @return bool */ public function is_fallback_population_allowed( $properties, $field ) { return false; } /** * Define field options to display in left panel. * * @since 1.7.6 * * @param array $field Field data and settings. */ public function field_options( $field ) { $this->field_option( 'basic-options', $field, [ 'markup' => 'open', ] ); $this->heading_option( $field ); $this->field_option( 'description', $field ); $this->expanded_description_option( $field ); $this->cta_label_option( $field ); $this->cta_link_option( $field ); $this->field_option( 'basic-options', $field, [ 'markup' => 'close', ] ); } /** * Define field preview on the right side on builder. * * @since 1.7.6 * * @param array $field Field data and settings. */ public function field_preview( $field ) { echo '
'; // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped echo wpforms_render( 'fields/internal-information/icon-lightbulb' ); echo '
'; $this->render_preview( 'heading', $field ); $this->render_preview( 'description', $field ); $this->render_preview( 'expanded-description', $field ); if ( $this->is_button_displayable( $field ) ) { echo '
'; echo $this->render_custom_preview( 'cta-button', $field, [] ); echo '
'; } echo '
'; // phpcs:enable WordPress.Security.EscapeOutput.OutputNotEscaped echo '
'; } /** * Checks if button is displayable. * * @since 1.7.6 * * @param array $field Field data. * * @return bool */ private function is_button_displayable( $field ) { return ! empty( $field['expanded-description'] ) || ( ! empty( $field['cta-label'] ) && ! empty( $field['cta-link'] ) ) || $this->is_editable(); } /** * Stub to make the field not visible in the front-end. * * @since 1.7.6 * * @param array $field Field data and settings. * @param array $field_atts Field attributes. * @param array $form_data Form data. */ public function field_display( $field, $field_atts, $form_data ) { } /** * Heading option. * * @since 1.7.6 * * @param array $field Field data and settings. */ private function heading_option( $field ) { $output = $this->field_element( 'label', $field, [ 'slug' => 'heading', 'value' => esc_html__( 'Heading', 'wpforms-lite' ), 'tooltip' => esc_attr__( 'Enter text for the form field heading.', 'wpforms-lite' ), ], false ); $output .= $this->field_element( 'text', $field, [ 'slug' => 'label', 'value' => ! empty( $field['label'] ) ? esc_attr( $field['label'] ) : '', ], false ); $this->field_element( 'row', $field, [ 'slug' => 'heading', 'content' => $output, ] ); } /** * Expanded description option. * * @since 1.7.6 * * @param array $field Field data and settings. */ private function expanded_description_option( $field ) { $output = $this->field_element( 'label', $field, [ 'slug' => 'expanded-description', 'value' => esc_html__( 'Expanded Content', 'wpforms-lite' ), 'tooltip' => esc_attr__( 'Enter text for the form field expanded description.', 'wpforms-lite' ), ], false ); $output .= $this->field_element( 'textarea', $field, [ 'slug' => 'expanded-description', 'value' => ! empty( $field['expanded-description'] ) ? esc_html( $field['expanded-description'] ) : '', ], false ); $output .= sprintf( '

%s

', esc_html__( 'Adds an expandable content area below the description.', 'wpforms-lite' ) ); $this->field_element( 'row', $field, [ 'slug' => 'expanded-description', 'content' => $output, ] ); } /** * CTA label option. * * @since 1.7.6 * * @param array $field Field data and settings. */ private function cta_label_option( $field ) { $output = $this->field_element( 'label', $field, [ 'slug' => 'cta-label', 'value' => esc_html__( 'CTA Label', 'wpforms-lite' ), 'tooltip' => esc_attr__( 'Enter label for the form field call to action button. The label will be ignored if the field has extended description content: in that case button will be used to expand the description content.', 'wpforms-lite' ), ], false ); $output .= $this->field_element( 'text', $field, [ 'slug' => 'cta-label', 'value' => ! empty( $field['cta-label'] ) ? esc_attr( $field['cta-label'] ) : esc_attr__( 'Learn More', 'wpforms-lite' ), ], false ); $this->field_element( 'row', $field, [ 'slug' => 'cta-label', 'content' => $output, ] ); } /** * CTA link option. * * @since 1.7.6 * * @param array $field Field data and settings. */ private function cta_link_option( $field ) { $output = $this->field_element( 'label', $field, [ 'slug' => 'cta-link', 'value' => esc_html__( 'CTA Link', 'wpforms-lite' ), 'tooltip' => esc_attr__( 'Enter the URL for the form field call to action button. URL will be ignored if the field has extended description content: in that case button will be used to expand the description content.', 'wpforms-lite' ), ], false ); $output .= $this->field_element( 'text', $field, [ 'slug' => 'cta-link', 'value' => ! empty( $field['cta-link'] ) ? esc_url( $field['cta-link'] ) : '', ], false ); $output .= sprintf( '

%s

', esc_html__( 'CTA is hidden if Expanded Content is used.', 'wpforms-lite' ) ); $this->field_element( 'row', $field, [ 'slug' => 'cta-link', 'content' => $output, ] ); } /** * Add CSS class to hide field settings when field is not editable. * * @since 1.7.6 * * @param string $option Field option to render. * @param array $field Field data and settings. * @param array $args Field preview arguments. * @param bool $echo Print or return the value. Print by default. * * @return string */ public function field_element( $option, $field, $args = [], $echo = true ) { if ( ! isset( $args['class'] ) ) { $args['class'] = ''; } if ( ! $this->is_editable() ) { $args['class'] .= ' wpforms-hidden '; } return parent::field_element( $option, $field, $args, $echo ); } /** * Render custom option preview on the right side of builder. * * @since 1.7.6 * * @param string $option Field option to render. * @param array $field Field data and settings. * @param array $args Field arguments. * * @return string */ private function render_custom_preview( $option, $field, $args = [] ) { // phpcs:ignore Generic.Metrics.CyclomaticComplexity.MaxExceeded, Generic.Metrics.CyclomaticComplexity.TooHigh $class = ! empty( $args['class'] ) ? wpforms_sanitize_classes( $args['class'] ) : ''; $allowed_tags = $this->get_allowed_tags(); switch ( $option ) { case 'heading': $label = isset( $field['label'] ) && ! wpforms_is_empty_string( $field['label'] ) ? esc_html( $field['label'] ) : ''; if ( ! $label ) { $class .= ' hidden '; } return sprintf( '', esc_attr( $class ), esc_html( $label ) ); case 'description': // phpcs:ignore WPForms.Formatting.Switch.AddEmptyLineBefore $description = isset( $field['description'] ) && ! empty( $field['description'] ) ? wp_kses( $field['description'], $allowed_tags ) : ''; $description = wpautop( $this->replace_checkboxes( $description, $field ) ); $description = $this->add_link_attributes( $description ); return sprintf( '
%s
', $class, $description ); case 'expanded-description': // phpcs:ignore WPForms.Formatting.Switch.AddEmptyLineBefore $description = isset( $field['expanded-description'] ) && ! wpforms_is_empty_string( $field['expanded-description'] ) ? wp_kses( $field['expanded-description'], $allowed_tags ) : ''; $description = wpautop( $this->replace_checkboxes( $description, $field ) ); $description = $this->add_link_attributes( $description ); return sprintf( '
%s
', esc_attr( $class ), wp_kses( $description, $allowed_tags ) ); case 'cta-button': // phpcs:ignore WPForms.Formatting.Switch.AddEmptyLineBefore $label = isset( $field['cta-label'] ) && ! empty( $field['cta-label'] ) && empty( $field['expanded-description'] ) ? esc_attr( $field['cta-label'] ) : esc_attr__( 'Learn More', 'wpforms-lite' ); if ( isset( $field['expanded-description'] ) && ! empty( $field['expanded-description'] ) ) { return sprintf( '
%s %s %s
', esc_attr( $class ), esc_html( $label ), wpforms_render( 'fields/internal-information/icon-not-expanded' ), wpforms_render( 'fields/internal-information/icon-expanded' ) ); } if ( isset( $field['cta-link'] ) && ! empty( $field['cta-link'] ) ) { return sprintf( '
%s
', esc_attr( $class ), esc_url( $this->add_url_utm( $field ) ), esc_html( $label ) ); } return sprintf( '
', esc_attr( $class ) ); } return ''; } /** * Display field button in left panel only if the field is editable. * * @since 1.7.6 * * @param array $fields All fields to display in the left panel. * * @return array */ public function field_button( $fields ) { if ( $this->is_editable() ) { return parent::field_button( $fields ); } return $fields; } /** * When the form is going to be displayed on front-end, remove internal information fields. * * @since 1.7.6 * * @param array $form_data Form data. * * @return array */ public function remove_internal_fields_on_front_end( $form_data ) { if ( empty( $form_data['fields'] ) ) { return $form_data; } foreach ( $form_data['fields'] as $id => $field ) { if ( $field['type'] === $this->type ) { unset( $form_data['fields'][ $id ] ); } } return $form_data; } /** * Remove field from form data before processing the form submit. * * @since 1.7.6 * * @param array $form_data Form data. * @param array $entry Form submission raw data ($_POST). * * @return array */ public function process_before_form_data( $form_data, $entry ) { return $this->remove_internal_fields_on_front_end( $form_data ); } /** * Do not display the duplicate button. * * @since 1.7.6 * * @param bool $is_visible If true, the duplicate button will be displayed. * @param array $field Field data and settings. * @param array $form_data Form data and settings. * * @return bool */ public function display_duplicate_button( $is_visible, $field, $form_data ) { if ( $this->is_internal_information_field( $field ) && ! $this->is_editable() ) { return false; } return $is_visible; } /** * Hide column from the entries list table. * * @since 1.7.6 * * @param array $disallowed Table columns. * * @return array */ public function hide_column_in_entries_table( $disallowed ) { $disallowed[] = $this->type; return $disallowed; } /** * Add CSS class for the field parent div informing about mode (editable or not). * * @since 1.7.6 * * @param string $css CSS classes. * @param array $field Field data and settings. * * @return string */ public function add_css_class_for_field_wrapper( $css, $field ) { if ( ! $this->is_internal_information_field( $field ) ) { return $css; } if ( $this->is_editable() ) { $css .= ' internal-information-editable '; return $css; } $css .= ' ui-sortable-disabled internal-information-not-editable internal-information-not-draggable '; return str_replace( 'ui-sortable-handle', '', $css ); } /** * Save checkbox state to the post meta table. * * @since 1.7.6 */ public function save_internal_information_checkbox() { // Run several checks: required items, security, permissions. if ( ! isset( $_POST['formId'], $_POST['name'], $_POST['checked'] ) || ! check_ajax_referer( 'wpforms-builder', 'nonce', false ) || ! wpforms_current_user_can( 'edit_forms' ) ) { wp_send_json_error(); } $form_id = (int) $_POST['formId']; $checked = (int) $_POST['checked']; $name = sanitize_text_field( wp_unslash( $_POST['name'] ) ); $post_meta = get_post_meta( $form_id, self::CHECKBOX_META_KEY, true ); $post_meta = ! empty( $post_meta ) ? (array) $post_meta : []; if ( $checked ) { $post_meta[ $name ] = $checked; } else { unset( $post_meta[ $name ] ); } update_post_meta( $form_id, self::CHECKBOX_META_KEY, $post_meta ); wp_send_json_success(); } /** * Localized strings for wpforms-internal-information-field JS script. * * @since 1.7.6 * * @param array $strings Localized strings. * @param array $form The form element. * * @return array * @noinspection PhpUnusedParameterInspection */ public function builder_strings( $strings, $form ) { $strings['iif_redirect_url_field_error'] = esc_html__( 'You should enter a valid absolute address to the CTA Link field or leave it empty.', 'wpforms-lite' ); $strings['iif_dismiss'] = esc_html__( 'Dismiss', 'wpforms-lite' ); $strings['iif_more'] = esc_html__( 'Learn More', 'wpforms-lite' ); return $strings; } /** * Enqueue wpforms-internal-information-field script. * * @since 1.7.6 * * @param string $view Current view. * * @noinspection PhpUnusedParameterInspection, PhpUnnecessaryCurlyVarSyntaxInspection */ public function builder_enqueues( $view ) { $min = wpforms_get_min_suffix(); wp_enqueue_script( 'wpforms-md5-hash', WPFORMS_PLUGIN_URL . 'assets/lib/md5.min.js', [ 'wpforms-builder' ], '2.19.0' ); wp_enqueue_script( 'wpforms-internal-information-field', WPFORMS_PLUGIN_URL . "assets/js/components/admin/fields/internal-information-field{$min}.js", [ 'wpforms-builder', 'wpforms-md5-hash', 'wpforms-builder-drag-fields' ], WPFORMS_VERSION ); } /** * Checks if user is allowed to edit the field's content. * * @since 1.7.6 * * @return bool */ private function is_editable() { /** * Allow changing a mode. * * @since 1.7.6 * * @param bool $is_editable True if editable mode is allowed. Default: false. */ return (bool) apply_filters( 'wpforms_field_internal_information_is_editable', false ); } /** * Check if the field has type internal-information. * * @since 1.7.6 * * @param array $field Field data. * * @return bool */ private function is_internal_information_field( $field ) { return isset( $field['type'] ) && $field['type'] === $this->type; } /** * Render result of field_preview_option into custom div. * * If field has no value, do not echo anything. * * @since 1.7.6 * * @param string $label Field label. * @param array $field Field settings and data. * @param array $args Field arguments. */ private function render_preview( $label, $field, $args = [] ) { $key = $label === 'heading' ? 'label' : $label; if ( empty( $field[ $key ] ) && ! $this->is_editable() ) { return; } $allowed_tags = $this->get_allowed_tags(); printf( '
%s
', esc_attr( $label ), wp_kses( $this->render_custom_preview( $label, $field, $args ), $allowed_tags ) ); } /** * Replace `[] some text` with checkboxes. * * Additionally, generates input name by hashing the line of text where the checkbox is. * * @since 1.7.6 * * @param string $description Expanded description. * @param array $field Field data and settings. * * @return string */ private function replace_checkboxes( $description, array $field ) { // phpcs:ignore Generic.Metrics.CyclomaticComplexity.TooHigh if ( ! $this->form_id ) { return $description; } $lines = explode( PHP_EOL, $description ); $replaced = []; $post_meta = get_post_meta( $this->form_id, self::CHECKBOX_META_KEY, true ); $post_meta = ! empty( $post_meta ) ? (array) $post_meta : []; $field_id = isset( $field['id'] ) ? $field['id'] : 0; $needle = '[] '; foreach ( $lines as $line_number => $line ) { $line = trim( $line ); if ( strpos( $line, $needle ) !== 0 ) { $replaced[] = $line . PHP_EOL; continue; } $field_name = sprintf( 'iif-%d-%s-%d', $field_id, md5( $line ), $line_number ); $checked = (int) isset( $post_meta[ $field_name ] ); $attributes = [ 'name' => esc_attr( $field_name ), 'value' => 1, ]; if ( $this->is_editable() ) { $attributes['disabled'] = 'disabled'; $attributes['title'] = esc_html__( 'This field is disabled in the editor mode.', 'wpforms-lite' ); } $html = sprintf( '
', wpforms_html_attributes( '', [ 'wpforms-field-internal-information-checkbox' ], [], $attributes ), ! $this->is_editable() ? checked( $checked, 1, false ) : '' ); $line = substr_replace( $line, $html, 0, strlen( $needle ) ); $replaced[] = '
' . $line . '
'; } return implode( '', $replaced ); } /** * Return allowed tags specific to internal information field content. * * @since 1.7.6 * * @return array */ private function get_allowed_tags() { $allowed_tags = wpforms_builder_preview_get_allowed_tags(); $allowed_tags['input'] = [ 'type' => [], 'name' => [], 'value' => [], 'class' => [], 'checked' => [], 'disabled' => [], 'title' => [], ]; return $allowed_tags; } /** * Adds link parameters to all links in the provided content. * * @since 1.8.3 * * @param string $content The content to modify. * * @return string The modified content with UTM parameters added to links. */ private function add_link_attributes( $content ) { if ( empty( $content ) || ! class_exists( 'DOMDocument' ) ) { return $content; } $dom = new DOMDocument(); $form_data = wpforms()->get( 'form' )->get( $this->form_id, [ 'content_only' => true ] ); $template_data = ! empty( $form_data['meta'] ) ? wpforms()->get( 'builder_templates' )->get_template( $form_data['meta']['template'] ) : []; $template_name = ! empty( $template_data ) ? $template_data['name'] : ''; $dom->loadHTML( htmlspecialchars_decode( htmlentities( $content ) ) ); $links = $dom->getElementsByTagName( 'a' ); foreach ( $links as $link ) { $href = $link->getAttribute( 'href' ); $text = $link->textContent; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase $modified_href = wpforms_utm_link( $href, 'Form Template Information Note', $template_name, $text ); $link->setAttribute( 'href', $modified_href ); $link->setAttribute( 'target', '_blank' ); $link->setAttribute( 'rel', 'noopener noreferrer' ); } // Remove the wrapper elements. $body = $dom->getElementsByTagName( 'body' )->item( 0 ); $inner_html = ''; foreach ( $body->childNodes as $node ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase $inner_html .= $dom->saveHTML( $node ); } return $inner_html; } /** * Add UTM parameters to the CTA button link. * * @since 1.7.6 * * @param array $field Field data. * * @return string */ private function add_url_utm( $field ) { if ( strpos( $field['cta-link'], 'https://wpforms.com' ) === 0 ) { return wpforms_utm_link( $field['cta-link'], 'Template Documentation' ); } return $field['cta-link']; } } new WPForms_Field_Internal_Information();