# html-forms/1.3.34/src/class-form.php

HTML Forms – Simple WordPress Forms Plugin, version 1.3.34. 193 lines.

- Page: https://pluginprobe.com/plugins/html-forms/1.3.34/code/src/class-form.php
- Raw: https://pluginprobe.com/plugins/html-forms/1.3.34/raw/src/class-form.php
- Modified: 2024-07-07T15:11:34+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/html-forms/1.3.34/code/src/class-form.php#L10-L20`.

```php
<?php

namespace HTML_Forms;

class Form {

	public $ID       = 0;
	public $title    = '';
	public $slug     = '';
	public $markup   = '';
	public $messages = array();
	public $settings = array();

	/**
	 * Form constructor.
	 *
	 * @param $id
	 */
	public function __construct( $id ) {
		$this->ID = $id;
	}

	/**
	* Magic method for accessing unexisting properties, eg lowercase "id".
	* @param string $property
	* @return mixed
	*/
	public function __get( $property ) {
		if ( $property === 'id' ) {
			return $this->ID;
		}
	}

	public function get_html() {
		$form = $this;

		/**
		 * Filters the CSS classes to be added to this form's class attribute.
		 *
		 * @param array $form_classes
		 * @param Form $form
		 */
		$form_classes_attr = apply_filters( 'hf_form_element_class_attr', '', $form );

		/**
		 * Filters the action attribute for this form.
		 *
		 * @param string $form_action
		 * @param Form $form
		 */
		$form_action      = apply_filters( 'hf_form_element_action_attr', null, $form );
		$form_action_attr = is_null( $form_action ) ? '' : sprintf( 'action="%s"', $form_action );

		$data_attributes = $this->get_data_attributes();

		$html  = '';
		$html .= sprintf( '<!-- HTML Forms v%s - %s -->', HTML_FORMS_VERSION, 'https://wordpress.org/plugins/html-forms/' );
		$html .= sprintf( '<form method="post" %s class="hf-form hf-form-%d %s" %s>', $form_action_attr, $this->ID, esc_attr( $form_classes_attr ), $data_attributes );

		$html .= sprintf( '<input type="hidden" name="_hf_form_id" value="%d" />', $this->ID );
		$html .= sprintf( '<div style="display: none;"><input type="text" name="_hf_h%d" value="" /></div>', $this->ID );
		$html .= '<div class="hf-fields-wrap">';
		$html .= $this->get_markup();
		$html .= '<noscript>' . __( 'Please enable JavaScript for this form to work.', 'html-forms' ) . '</noscript>';
		$html .= '</div>'; // end field wrap
		$html .= '</form>';
		$html .= '<!-- / HTML Forms -->';

		// ensure JS script is enqueued whenever this function is called
		if ( function_exists( 'wp_enqueue_script' ) ) {
			wp_enqueue_script( 'html-forms' );
		}

		/**
		 * Filters the resulting HTML for this form.
		 *
		 * @param string $html
		 * @param Form $form
		 */
		$html = apply_filters( 'hf_form_html', $html, $form );
		return $html;
	}

	public function get_data_attributes() {
		$form       = $this;
		$attributes = array(
			'id'    => $this->ID,
			'title' => $this->title,
			'slug'  => $this->slug,
		);

		// add messages
		foreach ( $this->messages as $key => $message ) {
			$key                             = str_replace( '_', '-', $key );
			$attributes[ 'message-' . $key ] = $message;
		}

		/**
		 * Filters the data attributes to be added to the form attribute.
		 *
		 * @param array $attributes
		 * @param Form $form
		 */
		$attributes = apply_filters( 'hf_form_element_data_attributes', $attributes, $form );

		// create string of attribute key-value pairs
		$string = '';
		foreach ( $attributes as $attr => $value ) {
			// prefix all attributes with data-
			if ( substr( $attr, 0, 5 ) !== 'data-' ) {
				$attr = 'data-' . $attr;
			}

			$string .= sprintf( '%s="%s" ', $attr, esc_attr( $value ) );
		}
		$string = rtrim( $string, ' ' );

		return $string;
	}


	/**
	 * @return string
	 */
	public function __toString() {
		return $this->get_html();
	}

	/**
	* @return string
	*/
	public function get_markup() {
		/**
		 * @param string $markup
		 * @param Form $form
		 */
		return apply_filters( 'hf_form_markup', $this->markup, $this );
	}

	/**
	 * @return array
	 */
	public function get_required_fields() {
		if ( empty( $this->settings['required_fields'] ) ) {
			return array();
		}

		$required_fields = explode( ',', $this->settings['required_fields'] );
		return $required_fields;
	}

	/**
	 * @return array
	 */
	public function get_email_fields() {
		if ( empty( $this->settings['email_fields'] ) ) {
			return array();
		}

		$email_fields = explode( ',', $this->settings['email_fields'] );
		return $email_fields;
	}

	/**
	* @param string $code
	* @return string
	*/
	public function get_message( $code ) {
		$form    = $this;
		$message = isset( $this->messages[ $code ] ) ? $this->messages[ $code ] : '';

		/**
		* @param string $message
		* @param Form $form
		*/
		$message = apply_filters( 'hf_form_message_' . $code, $message, $form );
		return $message;
	}

	/**
	* @return int The number of named fields in the form
	*
	* Note: this includes all default fields and an additional field for the "was-required" element we include in every request.
	*/
	public function get_field_count() {
		$pattern = '/\bname\s*=\s*["\']/i';
		preg_match_all( $pattern, $this->get_html(), $matches );
		$count = ! empty( $matches ) ? count( $matches[0] ) : 0;
		$count++; // Add one for 'was-required'
		return $count;
	}
}

```