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();
$settings = hf_get_settings();
$html = '';
$html .= sprintf( '', HTML_FORMS_VERSION, 'https://wordpress.org/plugins/html-forms/' ) . PHP_EOL;
$html .= sprintf( '';
$html .= '';
// 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;
}
}