{"id":217,"date":"2024-06-28T09:58:08","date_gmt":"2024-06-28T13:58:08","guid":{"rendered":"https:\/\/htmlformsplugin.com\/?p=217"},"modified":"2025-02-13T13:21:03","modified_gmt":"2025-02-13T18:21:03","slug":"code-snippets","status":"publish","type":"post","link":"https:\/\/htmlformsplugin.com\/kb\/code-snippets\/","title":{"rendered":"Code Snippets"},"content":{"rendered":"\n

Check out our collection of simple code snippets you can use to get the most out of HTML Forms on your WordPress websites.<\/p>\n\n\n\n

Add Class Attribute to Form Tag<\/h2>\n\n\n\n
add_filter(\n\t'hf_form_element_class_attr',\n\tfunction( $class_attr ) {\n\t\treturn $class_attr . ' my-class';\n\t}\n);<\/code><\/pre>\n\n\n\n
\n\n\n\n
Add Custom Attribute to Form Tag<\/h2>\n\n\n\n
add_filter(\n\t'hf_form_html',\n\tfunction( $html ) {\n\t\t$html = str_replace( '<form ', '<form ms-signup=\"true\" ', $html );\n\t\treturn $html;\n\t}\n);<\/code><\/pre>\n\n\n\n
\n\n\n\n
Add Custom Form Action<\/h2>\n\n\n\n
use HTML_Forms\\Actions\\Action;\nuse HTML_Forms\\Form;\nuse HTML_Forms\\Submission;\n\nclass MyCustomAction extends Action {\n\n\tpublic $type  = 'pushbullet';\n\tpublic $label = '';\n\n\tpublic function __construct() {\n\t\t$this->label = __( 'Send to Pushbullet', 'html-forms' );\n\t}\n\n\t\/**\n\t * @return array\n\t *\/\n\tprivate function get_default_settings() {\n\t\treturn array(\n\t\t\t'url' => '',\n\t\t);\n\t}\n\n\t\/**\n\t * @param array $settings\n\t * @param string|int $index\n\t *\/\n\tpublic function page_settings( $settings, $index ) {\n\t\t$settings = array_merge( $this->get_default_settings(), $settings );\n\t\t?>\n\t\t<span class=\"hf-action-summary\"><?php printf( 'Pushbullet' ); ?><\/span>\n\t\t<input type=\"hidden\" name=\"form[settings][actions][<?php echo $index; ?>][type]\" value=\"<?php echo $this->type; ?>\" \/>\n\t\t<table class=\"form-table\">\n\t\t\t<tr>\n\t\t\t\t<th><label><?php echo __( 'Pushbullet API URL', 'html-forms' ); ?> <span class=\"hf-required\">*<\/span><\/label><\/th>\n\t\t\t\t<td>\n\t\t\t\t\t<input name=\"form[settings][actions][<?php echo $index; ?>][url]\" value=\"<?php echo esc_attr( $settings['url'] ); ?>\" type=\"text\" class=\"regular-text\" placeholder=\"http:\/\/....\" required \/>\n\t\t\t\t<\/td>\n\t\t\t<\/tr>\n\t\t<\/table>\n\t\t<?php\n\t}\n\n\t\/**\n\t * Processes this action\n\t *\n\t * @param array $settings\n\t * @param Submission $submission\n\t * @param Form $form\n\t *\/\n\tpublic function process( array $settings, Submission $submission, Form $form ) {\n\t\t\/\/ TODO: Send HTTP request to PushBullet API URL: $settings['url']\n\t}\n}\n\n$my_custom_action = new MyCustomAction();\n$my_custom_action->hook();<\/code><\/pre>\n\n\n\n
\n\n\n\n
Add HTML to Form Dynamically<\/h2>\n\n\n\n
add_filter(\n\t'hf_form_markup',\n\tfunction( $markup ) {\n\t\t$markup .= '<input type=\"hidden\" name=\"HIDDEN_FIELD\" value=\"My value\" \/>';\n\t\treturn $markup;\n\t}\n);\n<\/code><\/pre>\n\n\n\n
HTML forms will check the number of configured fields versus the number of submitted fields, and ignore the submission if it’s mismatching. For that reason, if you like to dynamically add more than 1 field dynamically, you need to disable the field counter with the following filter:<\/p>\n\n\n\n
add_filter( 'hf_validate_form_request_size', '__return_false' );<\/code><\/pre>\n\n\n\n
\n\n\n\n
Add Tag to Mailchimp Contact<\/h2>\n\n\n\n
This requires the MC4WP<\/a> plugin to be active and configured. <\/p>\n\n\n\n
Give users a link to a form, and include “?hfmuc_email={{their_email}}” as a querystring parameter.<\/p>\n\n\n\n
Then make sure the form has a hidden field named “EMAIL” whose value is “{{hfmuc_email}}” like this example:<\/p>\n\n\n\n
<input type=\"hidden\" name=\"EMAIL\" placeholder=\"Your email\" required value=\"{{hfmuc_email}}\" \/><\/code><\/code><\/pre>\n\n\n\n
Find your list ID<\/a> and put it in $list_id below. Then local the HTML Forms slug (seen when editing the form) and put it in $form_slug. Next, add any tags you want to $tags_data.<\/p>\n\n\n\n
Now the user will get a link to the form, fill it out (no need to re-enter their email), and upon successful submission, those tags will be added to their Mailchimp contact.<\/p>\n\n\n\n
use \\HTML_Forms\\Submission;\nuse HTML_Forms\\Form;\n\n\/\/ Get the user's email from the query parameters\nadd_filter(\n\t'hf_form_html',\n\tfunction ( $html ) {\n\t\t$email = isset( $_GET['hfmuc_email'] ) ? $_GET['hfmuc_email'] : '';\n\t\treturn str_replace( '{{hfmuc_email}}', $email, $html );\n\t}\n);\n\/\/ Adds tags to the given user.\nadd_action(\n\t'hf_form_success',\n\tfunction ( $submission, $form ) {\n\t\t\/\/ Check that it's the right form.\n\t\t$form_slug = 'survey-1';\n\t\tif ( $form->slug !== $form_slug ) {\n\t\t\treturn;\n\t\t}\n\n\t\t$email_address = $submission->data['EMAIL'];\n\t\t$api           = mc4wp_get_api_v3();\n\n\t\t\/\/ aka \"audience ID\". See https:\/\/mailchimp.com\/help\/find-audience-id\/\n\t\t$list_id = '32ccd044c3';\n\n\t\t\/\/ see https:\/\/mailchimp.com\/developer\/reference\/lists\/list-members\/list-member-tags\/#read-get_lists_list_id_members_subscriber_hash_tags\n\t\t$tags_data = array(\n\t\t\t'tags' => array(\n\t\t\t\tarray(\n\t\t\t\t\t'name'   => 'Test',\n\t\t\t\t\t'status' => 'active',\n\t\t\t\t),\n\t\t\t),\n\t\t);\n\n\t\t$result = $api->update_list_member_tags(\n\t\t\t$list_id,\n\t\t\t$email_address,\n\t\t\t$tags_data\n\t\t);\n\t},\n\t10,\n\t2\n);<\/code><\/pre>\n\n\n\n
\n\n\n\n
Add URL to Email Message<\/h2>\n\n\n\n
It’s possible to filter the email action message with PHP. This example will add the URL the form was submitted from to the end of the email notification message.<\/p>\n\n\n\n
add_filter(\n\t'hf_action_email_message',\n\tfunction ( $message ) {\n\t\treturn $message . sprintf( '<br \/>Referrer URL: %s', esc_html( $_SERVER['REQUEST_URI'] ) );\n\t}\n);<\/code><\/pre>\n\n\n\n
\n\n\n\n
Custom Form Message<\/h2>\n\n\n\n
The default message keys are:<\/p>\n\n\n\n