stereo/contact-form

Zero Config contact form with logging

Maintainers

Details

github.com/stereoweb/stereo-contactform

Homepage

Source

Issues

Installs: 2 568

Dependents: 0

Suggesters: 0

Security: 0

Stars: 3

Watchers: 2

Forks: 0

Open Issues: 7

Type:wordpress-plugin

2.3.1 2024-06-21 18:45 UTC

Requires

  • php: >=5.6

0BSD b7e6262c1c20db6c459abd9e55b29c58fb84b5ba

  • Stereo <support.woop@stereo.ca>

pluginformwordpresscontact

This package is auto-updated.

Last update: 2025-03-21 20:25:05 UTC

README

Zero Config Contact Form with Logging for Wordpress

Getting Started

Install the plugin with the informations specified here

Prerequisites

Wordpress with Bedrock, jQuery loaded.

Installing

composer require stereo/contact-form

Usage

Create forms in raw html and add class "js-stereo-cf" to your form.

<form class="[any other classes] js-stereo-cf">
    <textarea name="message" required></textarea>
    <input type="submit">
</form>
<div style="display:none">Thanks.</div>

With this code, an email with the message content will be sent to the admin email of your Wordpress installation.

The subject will be "Formulaire de contact"

It will be logged in your Wordpress Administration, with the date, followed by the first field of your form.

Want to reset form and keet it visible after send?

<form class="[any other classes] js-stereo-cf" data-reset-only>

Want to change the email subject to better fit your needs?

<form class="[any other classes] js-stereo-cf" data-subject="Formulaire de contact de ma mère">
    <textarea name="message" required></textarea>
    <input type="submit">
</form>
<div style="display:none">Thanks.</div>

Want to change the title field in the Wordpress Administration ?

Setting the data-title to a comma seperated list of fields will concatenate each with a space between.

<form class="[any other classes] js-stereo-cf" data-title="Prenom,Nom">
    <input name="Prenom" required>
    <input name="Nom" required>
    <input type="submit">
</form>
<div style="display:none">Thanks.</div>

Want to set a category to filter the Administration list in case of multiple forms ?

The default category is Contact

<form class="[any other classes] js-stereo-cf" data-category="Subscription">
    <input name="Prenom" required>
    <input name="Nom" required>
    <input type="submit">
</form>
<div style="display:none">Thanks.</div>

Want to redirect on success ?

Set data-redirect with the redirect url

<form class="[any other classes] js-stereo-cf" data-redirect="/success">
    <input name="Prenom" required>
    <input name="Nom" required>
    <input type="submit">
</form>
<div style="display:none">Thanks.</div>

Manipulate the "TO" email address

If you want the email to go somewhere else :

add_filter('st_cf_mail_to',function() {
    return 'Your Mom <yourmom@gmail.com>';
});

Manipulate the "FROM" email address

If you want the email to get from somewhere else :

add_filter('st_cf_mail_from',function() {
    return 'Your Mom <yourmom@gmail.com>';
});

Manipulate the subject of the email

If you want to change the subject of emails :

add_filter('st_cf_mail_subject',function($subject) {
    return '[My rebranded CMS] '.$subject;
});

Manipulate the content of the email

If you want to add templating to your email :

add_filter('st_cf_mail_content',function($content) {
    return '<html><body style="background:pink;">'.$content.'</body></html>';
});

HEADERS

Default mail headers are :

'From: '.$from
'Content-Type: text/html; charset=UTF-8'

If you have a "Courriel" field a replyTo will be added to your headers.

Field name can be changed

add_filter('st_cf_mail_field',function($field) {
    return 'Email';
});

Modify mail headers array

add_filter('st_cf_mail_headers',function($headers) {
    $headers[] = "X-Some: More-Headers";
    return $headers;
});

Modify basic message on top of email

add_filter('st_cf_mailmsg',function($msg) {
    return 'New form entry : ';
    // Default : Nouveau formulaire reçu, voici l'information
});

HEADERS

Default mail headers are :

'From: '.$from
'Content-Type: text/html; charset=UTF-8'

If you have a "Courriel" field a replyTo will be added to your headers.

Field name can be changed

add_filter('st_cf_mail_field',function($field) {
    return 'Email';
});

Modify mail headers array

add_filter('st_cf_mail_headers',function($headers) {
    $headers[] = "X-Some: More-Headers";
    return $headers;
});

Add callback function

<form class="[any other classes] js-stereo-cf" data-callback="functionName">
    <input name="Prenom" required>
    <input name="Nom" required>
    <input type="submit">
</form>
<div style="display:none">Thanks.</div>

Handle uploaded files

All uploaded files with name file[] are sent by email by default, but if you want to do anything else with them : If you don't want to uploads file on the server use _file[]

This hook is not triggered if there are no uploaded files.

$files = array of files $postid = ID of saved post ID

add_action('st_cf_files',function($files,$postid) {
    foreach($files as $f)  {
        // $f is a temp file path that will be deleted after this hook.
    }
}, 10, 2);

Handle files upload by external source

Send files in mail uploaded before the form is submitted :

Files will be removed from the server after the form is sent. Handle uploaded files if you want to keep them.

$files = array of files

add_filter('st_cf_files_external',function($files, $post_id) {
    $files[] = $file_name;
    return $files;
}, 10, 2);

Init forms on demands

if (window.initStereoForm) window.initStereoForm();