Grunion_Contact_Form_Field

Class for the contact-field shortcode.

Defined (1)

The class is defined in the following location(s).

/modules/contact-form/grunion-contact-form.php  
  1. class Grunion_Contact_Form_Field extends Crunion_Contact_Form_Shortcode { 
  2.     public $shortcode_name = 'contact-field'; 
  3.  
  4.     /** 
  5.      * @var Grunion_Contact_Form parent form 
  6.      */ 
  7.     public $form; 
  8.  
  9.     /** 
  10.      * @var string default or POSTed value 
  11.      */ 
  12.     public $value; 
  13.  
  14.     /** 
  15.      * @var bool Is the input invalid? 
  16.      */ 
  17.     public $error = false; 
  18.  
  19.     /** 
  20.      * @param array $attributes An associative array of shortcode attributes.  @see shortcode_atts() 
  21.      * @param null|string $content Null for selfclosing shortcodes.  The inner content otherwise. 
  22.      * @param Grunion_Contact_Form $form The parent form 
  23.      */ 
  24.     function __construct( $attributes, $content = null, $form = null ) { 
  25.         $attributes = shortcode_atts( array( 
  26.             'label' => null,  
  27.             'type' => 'text',  
  28.             'required' => false,  
  29.             'options' => array(),  
  30.             'id' => null,  
  31.             'default' => null,  
  32.             'placeholder' => null,  
  33.  ), $attributes, 'contact-field' ); 
  34.  
  35.         // special default for subject field 
  36.         if ( 'subject' == $attributes['type'] && is_null( $attributes['default'] ) && !is_null( $form ) ) { 
  37.             $attributes['default'] = $form->get_attribute( 'subject' ); 
  38.         } 
  39.  
  40.         // allow required=1 or required=true 
  41.         if ( '1' == $attributes['required'] || 'true' == strtolower( $attributes['required'] ) ) 
  42.             $attributes['required'] = true; 
  43.         else 
  44.             $attributes['required'] = false; 
  45.  
  46.         // parse out comma-separated options list (for selects, radios, and checkbox-multiples) 
  47.         if ( !empty( $attributes['options'] ) && is_string( $attributes['options'] ) ) { 
  48.             $attributes['options'] = array_map( 'trim', explode( ', ', $attributes['options'] ) ); 
  49.         } 
  50.  
  51.         if ( $form ) { 
  52.             // make a unique field ID based on the label, with an incrementing number if needed to avoid clashes 
  53.             $form_id = $form->get_attribute( 'id' ); 
  54.             $id = isset( $attributes['id'] ) ? $attributes['id'] : false; 
  55.  
  56.             $unescaped_label = $this->unesc_attr( $attributes['label'] ); 
  57.             $unescaped_label = str_replace( '%', '-', $unescaped_label ); // jQuery doesn't like % in IDs? 
  58.             $unescaped_label = preg_replace( '/[^a-zA-Z0-9.-_:]/', '', $unescaped_label ); 
  59.  
  60.             if ( empty( $id ) ) { 
  61.                 $id = sanitize_title_with_dashes( 'g' . $form_id . '-' . $unescaped_label ); 
  62.                 $i = 0; 
  63.                 $max_tries = 99; 
  64.                 while ( isset( $form->fields[$id] ) ) { 
  65.                     $i++; 
  66.                     $id = sanitize_title_with_dashes( 'g' . $form_id . '-' . $unescaped_label . '-' . $i ); 
  67.  
  68.                     if ( $i > $max_tries ) { 
  69.                         break; 
  70.                     } 
  71.                 } 
  72.             } 
  73.  
  74.             $attributes['id'] = $id; 
  75.         } 
  76.  
  77.         parent::__construct( $attributes, $content ); 
  78.  
  79.         // Store parent form 
  80.         $this->form = $form; 
  81.     } 
  82.  
  83.     /** 
  84.      * This field's input is invalid.  Flag as invalid and add an error to the parent form 
  85.      * 
  86.      * @param string $message The error message to display on the form. 
  87.      */ 
  88.     function add_error( $message ) { 
  89.         $this->is_error = true; 
  90.  
  91.         if ( !is_wp_error( $this->form->errors ) ) { 
  92.             $this->form->errors = new WP_Error; 
  93.         } 
  94.  
  95.         $this->form->errors->add( $this->get_attribute( 'id' ), $message ); 
  96.     } 
  97.  
  98.     /** 
  99.      * Is the field input invalid? 
  100.      * 
  101.      * @see $error 
  102.      * 
  103.      * @return bool 
  104.      */ 
  105.     function is_error() { 
  106.         return $this->error; 
  107.     } 
  108.  
  109.     /** 
  110.      * Validates the form input 
  111.      */ 
  112.     function validate() { 
  113.         // If it's not required, there's nothing to validate 
  114.         if ( !$this->get_attribute( 'required' ) ) { 
  115.             return; 
  116.         } 
  117.  
  118.         $field_id = $this->get_attribute( 'id' ); 
  119.         $field_type = $this->get_attribute( 'type' ); 
  120.         $field_label = $this->get_attribute( 'label' ); 
  121.  
  122.         $field_value = isset( $_POST[$field_id] ) ? stripslashes( $_POST[$field_id] ) : ''; 
  123.  
  124.         switch ( $field_type ) { 
  125.         case 'email' : 
  126.             // Make sure the email address is valid 
  127.             if ( !is_email( $field_value ) ) { 
  128.                 $this->add_error( sprintf( __( '%s requires a valid email address', 'jetpack' ), $field_label ) ); 
  129.             } 
  130.             break; 
  131.         default : 
  132.             // Just check for presence of any text 
  133.             if ( !strlen( trim( $field_value ) ) ) { 
  134.                 $this->add_error( sprintf( __( '%s is required', 'jetpack' ), $field_label ) ); 
  135.             } 
  136.         } 
  137.     } 
  138.  
  139.     /** 
  140.      * Outputs the HTML for this form field 
  141.      * 
  142.      * @return string HTML 
  143.      */ 
  144.     function render() { 
  145.         global $current_user, $user_identity; 
  146.  
  147.         $r = ''; 
  148.  
  149.         $field_id = $this->get_attribute( 'id' ); 
  150.         $field_type = $this->get_attribute( 'type' ); 
  151.         $field_label = $this->get_attribute( 'label' ); 
  152.         $field_required = $this->get_attribute( 'required' ); 
  153.         $placeholder = $this->get_attribute( 'placeholder' ); 
  154.         $field_placeholder = ( ! empty( $placeholder ) ) ? "placeholder='" . esc_attr( $placeholder ) . "'" : ''; 
  155.  
  156.         if ( isset( $_POST[ $field_id ] ) ) { 
  157.             if ( is_array( $_POST[ $field_id ] ) ) { 
  158.                 $this->value = array_map( 'stripslashes', $_POST[ $field_id ] ); 
  159.             } else { 
  160.                 $this->value = stripslashes( (string) $_POST[ $field_id ] ); 
  161.             } 
  162.         } elseif ( isset( $_GET[ $field_id ] ) ) { 
  163.             $this->value = stripslashes( (string) $_GET[ $field_id ] ); 
  164.         } elseif ( 
  165.             is_user_logged_in() && 
  166.             ( ( defined( 'IS_WPCOM' ) && IS_WPCOM ) || 
  167.             /** 
  168.              * Allow third-party tools to prefill the contact form with the user's details when they're logged in. 
  169.              * 
  170.              * @module contact-form 
  171.              * 
  172.              * @since 3.2.0 
  173.              * 
  174.              * @param bool false Should the Contact Form be prefilled with your details when you're logged in. Default to false. 
  175.              */ 
  176.             true === apply_filters( 'jetpack_auto_fill_logged_in_user', false ) 
  177.  ) 
  178.  ) { 
  179.             // Special defaults for logged-in users 
  180.             switch ( $this->get_attribute( 'type' ) ) { 
  181.             case 'email' : 
  182.                 $this->value = $current_user->data->user_email; 
  183.                 break; 
  184.             case 'name' : 
  185.                 $this->value = $user_identity; 
  186.                 break; 
  187.             case 'url' : 
  188.                 $this->value = $current_user->data->user_url; 
  189.                 break; 
  190.             default : 
  191.                 $this->value = $this->get_attribute( 'default' ); 
  192.             } 
  193.         } else { 
  194.             $this->value = $this->get_attribute( 'default' ); 
  195.         } 
  196.  
  197.         $field_value = Grunion_Contact_Form_Plugin::strip_tags( $this->value ); 
  198.         $field_label = Grunion_Contact_Form_Plugin::strip_tags( $field_label ); 
  199.  
  200.         switch ( $field_type ) { 
  201.         case 'email' : 
  202.             $r .= "\n<div>\n"; 
  203.             $r .= "\t\t<label for='" . esc_attr( $field_id ) . "' class='grunion-field-label email" . ( $this->is_error() ? ' form-error' : '' ) . "'>" . esc_html( $field_label ) . ( $field_required ? '<span>' . __( "(required)", 'jetpack' ) . '</span>' : '' ) . "</label>\n"; 
  204.             $r .= "\t\t<input type='email' name='" . esc_attr( $field_id ) . "' id='" . esc_attr( $field_id ) . "' value='" . esc_attr( $field_value ) . "' class='email' " . $field_placeholder . " " . ( $field_required ? "required aria-required='true'" : "" ) . "/>\n"; 
  205.             $r .= "\t</div>\n"; 
  206.             break; 
  207.         case 'telephone' : 
  208.             $r .= "\n<div>\n"; 
  209.             $r .= "\t\t<label for='" . esc_attr( $field_id ) . "' class='grunion-field-label telephone" . ( $this->is_error() ? ' form-error' : '' ) . "'>" . esc_html( $field_label ) . ( $field_required ? '<span>' . __( "(required)", 'jetpack' ) . '</span>' : '' ) . "</label>\n"; 
  210.             $r .= "\t\t<input type='tel' name='" . esc_attr( $field_id ) . "' id='" . esc_attr( $field_id ) . "' value='" . esc_attr( $field_value ) . "' class='telephone' " . $field_placeholder . "/>\n"; 
  211.         case 'textarea' : 
  212.             $r .= "\n<div>\n"; 
  213.             $r .= "\t\t<label for='contact-form-comment-" . esc_attr( $field_id ) . "' class='grunion-field-label textarea" . ( $this->is_error() ? ' form-error' : '' ) . "'>" . esc_html( $field_label ) . ( $field_required ? '<span>' . __( "(required)", 'jetpack' ) . '</span>' : '' ) . "</label>\n"; 
  214.             $r .= "\t\t<textarea name='" . esc_attr( $field_id ) . "' id='contact-form-comment-" . esc_attr( $field_id ) . "' rows='20' " . $field_placeholder . " " . ( $field_required ? "required aria-required='true'" : "" ) . ">" . esc_textarea( $field_value ) . "</textarea>\n"; 
  215.             $r .= "\t</div>\n"; 
  216.             break; 
  217.         case 'radio' : 
  218.             $r .= "\t<div><label class='grunion-field-label" . ( $this->is_error() ? ' form-error' : '' ) . "'>" . esc_html( $field_label ) . ( $field_required ? '<span>' . __( "(required)", 'jetpack' ) . '</span>' : '' ) . "</label>\n"; 
  219.             foreach ( $this->get_attribute( 'options' ) as $option ) { 
  220.                 $option = Grunion_Contact_Form_Plugin::strip_tags( $option ); 
  221.                 $r .= "\t\t<label class='grunion-radio-label radio" . ( $this->is_error() ? ' form-error' : '' ) . "'>"; 
  222.                 $r .= "<input type='radio' name='" . esc_attr( $field_id ) . "' value='" . esc_attr( $option ) . "' class='radio' " . checked( $option, $field_value, false ) . " " . ( $field_required ? "required aria-required='true'" : "" ) . "/> "; 
  223.                 $r .= esc_html( $option ) . "</label>\n"; 
  224.                 $r .= "\t\t<div class='clear-form'></div>\n"; 
  225.             } 
  226.             $r .= "\t\t</div>\n"; 
  227.             break; 
  228.         case 'checkbox' : 
  229.             $r .= "\t<div>\n"; 
  230.             $r .= "\t\t<label class='grunion-field-label checkbox" . ( $this->is_error() ? ' form-error' : '' ) . "'>\n"; 
  231.             $r .= "\t\t<input type='checkbox' name='" . esc_attr( $field_id ) . "' value='" . esc_attr__( 'Yes', 'jetpack' ) . "' class='checkbox' " . checked( (bool) $field_value, true, false ) . " " . ( $field_required ? "required aria-required='true'" : "" ) . "/> \n"; 
  232.             $r .= "\t\t" . esc_html( $field_label ) . ( $field_required ? '<span>'. __( "(required)", 'jetpack' ) . '</span>' : '' ) . "</label>\n"; 
  233.             $r .= "\t\t<div class='clear-form'></div>\n"; 
  234.             $r .= "\t</div>\n"; 
  235.             break; 
  236.         case 'checkbox-multiple' : 
  237.             $r .= "\t<div><label class='grunion-field-label" . ( $this->is_error() ? ' form-error' : '' ) . "'>" . esc_html( $field_label ) . ( $field_required ? '<span>' . __( "(required)", 'jetpack' ) . '</span>' : '' ) . "</label>\n"; 
  238.             foreach ( $this->get_attribute( 'options' ) as $option ) { 
  239.                 $option = Grunion_Contact_Form_Plugin::strip_tags( $option ); 
  240.                 $r .= "\t\t<label class='grunion-checkbox-multiple-label checkbox-multiple" . ( $this->is_error() ? ' form-error' : '' ) . "'>"; 
  241.                 $r .= "<input type='checkbox' name='" . esc_attr( $field_id ) . "[]' value='" . esc_attr( $option ) . "' class='checkbox-multiple' " . checked( in_array( $option, (array) $field_value ), true, false ) . " /> "; 
  242.                 $r .= esc_html( $option ) . "</label>\n"; 
  243.                 $r .= "\t\t<div class='clear-form'></div>\n"; 
  244.             } 
  245.             $r .= "\t\t</div>\n"; 
  246.             break; 
  247.         case 'select' : 
  248.             $r .= "\n<div>\n"; 
  249.             $r .= "\t\t<label for='" . esc_attr( $field_id ) . "' class='grunion-field-label select" . ( $this->is_error() ? ' form-error' : '' ) . "'>" . esc_html( $field_label ) . ( $field_required ? '<span>'. __( "(required)", 'jetpack' ) . '</span>' : '' ) . "</label>\n"; 
  250.             $r .= "\t<select name='" . esc_attr( $field_id ) . "' id='" . esc_attr( $field_id ) . "' class='select' " . ( $field_required ? "required aria-required='true'" : "" ) . ">\n"; 
  251.             foreach ( $this->get_attribute( 'options' ) as $option ) { 
  252.                 $option = Grunion_Contact_Form_Plugin::strip_tags( $option ); 
  253.                 $r .= "\t\t<option" . selected( $option, $field_value, false ) . ">" . esc_html( $option ) . "</option>\n"; 
  254.             } 
  255.             $r .= "\t</select>\n"; 
  256.             $r .= "\t</div>\n"; 
  257.             break; 
  258.         case 'date' : 
  259.             $r .= "\n<div>\n"; 
  260.             $r .= "\t\t<label for='" . esc_attr( $field_id ) . "' class='grunion-field-label " . esc_attr( $field_type ) . ( $this->is_error() ? ' form-error' : '' ) . "'>" . esc_html( $field_label ) . ( $field_required ? '<span>' . __( "(required)", 'jetpack' ) . '</span>' : '' ) . "</label>\n"; 
  261.             $r .= "\t\t<input type='date' name='" . esc_attr( $field_id ) . "' id='" . esc_attr( $field_id ) . "' value='" . esc_attr( $field_value ) . "' class='" . esc_attr( $field_type ) . "' " . ( $field_required ? "required aria-required='true'" : "" ) . "/>\n"; 
  262.             $r .= "\t</div>\n"; 
  263.  
  264.             wp_enqueue_script( 'grunion-frontend', plugins_url( 'js/grunion-frontend.js', __FILE__ ), array( 'jquery', 'jquery-ui-datepicker' ) ); 
  265.             break; 
  266.         default : // text field 
  267.             // note that any unknown types will produce a text input, so we can use arbitrary type names to handle 
  268.             // input fields like name, email, url that require special validation or handling at POST 
  269.             $r .= "\n<div>\n"; 
  270.             $r .= "\t\t<label for='" . esc_attr( $field_id ) . "' class='grunion-field-label " . esc_attr( $field_type ) . ( $this->is_error() ? ' form-error' : '' ) . "'>" . esc_html( $field_label ) . ( $field_required ? '<span>' . __( "(required)", 'jetpack' ) . '</span>' : '' ) . "</label>\n"; 
  271.             $r .= "\t\t<input type='text' name='" . esc_attr( $field_id ) . "' id='" . esc_attr( $field_id ) . "' value='" . esc_attr( $field_value ) . "' class='" . esc_attr( $field_type ) . "' " . $field_placeholder . " " . ( $field_required ? "required aria-required='true'" : "" ) . "/>\n"; 
  272.             $r .= "\t</div>\n"; 
  273.         } 
  274.  
  275.         /** 
  276.          * Filter the HTML of the Contact Form. 
  277.          * 
  278.          * @module contact-form 
  279.          * 
  280.          * @since 2.6.0 
  281.          * 
  282.          * @param string $r Contact Form HTML output. 
  283.          * @param string $field_label Field label. 
  284.          * @param int|null $id Post ID. 
  285.          */ 
  286.         return apply_filters( 'grunion_contact_form_field_html', $r, $field_label, ( in_the_loop() ? get_the_ID() : null ) ); 
  287.     } 
  288. }