Skip to content

ezcontactform/wordpress

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

EZCONTACTFORM WordPress Plugin

WordPress PHP License

Easily embed EZCONTACTFORM contact forms into your WordPress site using Gutenberg blocks or shortcodes.

Features

  • 🚀 Easy Integration - Add forms with Gutenberg blocks or simple shortcodes
  • 🎨 Customizable Display - Inline or button/modal display modes
  • 🌓 Theme Support - Light, dark, and system (auto-detect) themes
  • 📱 Fully Responsive - Works perfectly on all devices
  • Lightweight - Minimal performance impact
  • 🔧 Configurable - Global settings with per-form overrides
  • 🎯 Multiple Forms - Add multiple forms to any page
  • Accessible - WCAG compliant with ARIA labels

Requirements

  • WordPress 5.0 or higher
  • PHP 7.4 or higher
  • An EZCONTACTFORM account with a Form ID (Sign up for free)

Important: You must create an account at www.ezcontactform.com and create at least one form to get a Form ID before using this plugin.

Installation

Option 1: Install from WordPress.org (Recommended)

  1. In your WordPress admin panel, go to Plugins > Add New
  2. Search for "EZCONTACTFORM"
  3. Click Install Now then Activate

Option 2: Manual Installation

  1. Download the latest release from GitHub Releases
  2. In your WordPress admin panel, go to Plugins > Add New > Upload Plugin
  3. Choose the downloaded ZIP file and click Install Now
  4. Click Activate Plugin

Option 3: Install from Source

# Clone the repository
git clone https://github.com/ezcontactform/wordpress.git

# Copy plugin to WordPress plugins directory
cp -r wordpress/ezcontactform /path/to/wordpress/wp-content/plugins/

# Activate via WordPress admin or WP-CLI
wp plugin activate ezcontactform

Quick Start

1. Get Your Form ID (Required)

You must have a Form ID to use this plugin. Get one by:

  1. Visit www.ezcontactform.com
  2. Sign up for a free account (or log in if you have one)
  3. Create a new form in your dashboard
  4. Copy your Form ID (also called Source ID) - you'll need this!

Example Form ID: abc123xyz

2. Configure Plugin Settings

  1. In WordPress admin, go to Settings > EZCONTACTFORM
  2. Enter your Form ID (from step 1)
  3. Choose widget version (latest or pinned)
  4. Select default theme and display mode
  5. Click Save Settings

Note: You can use a global Form ID here, or specify different Form IDs per block/shortcode.

3. Add Form to Your Site

Using Gutenberg Block (Recommended)

  1. Edit any page or post
  2. Click the + button to add a block
  3. Search for "EZCONTACTFORM"
  4. Select the block and enter your Form ID
  5. Configure display mode, theme, and button text
  6. Publish or update the page

Using Shortcode

Add this shortcode anywhere in your content:

[ezcontactform id="YOUR_FORM_ID"]

Usage

Shortcode Examples

Basic inline form:

[ezcontactform id="abc123"]

With dark theme:

[ezcontactform id="abc123" theme="dark"]

Button that opens modal:

[ezcontactform id="abc123" display="button" button_text="Contact Us"]

All options:

[ezcontactform id="abc123" display="button" button_text="Get Started" theme="dark" container="my-form"]

Shortcode Attributes

Attribute Options Default Description
id string (required) Your EZCONTACTFORM form ID
display inline, button inline How to display the form
theme system, light, dark system Color theme
button_text string Contact Us Button text (button mode only)
container string auto Custom container HTML ID

Display Modes

Inline Mode

Form appears directly in your page content.

Best for:

  • Dedicated contact pages
  • Main content areas
  • Form-focused landing pages

Button/Modal Mode

A button that opens the form in a modal overlay.

Best for:

  • Sidebars and widgets
  • Footers
  • Call-to-action buttons
  • Space-constrained areas

Features:

  • Click button to open
  • Close via × button, ESC key, or clicking outside
  • Prevents page scroll when open
  • Fully accessible

Themes

  • System - Auto-detects user's OS preference (light/dark mode)
  • Light - Always light theme
  • Dark - Always dark theme

Settings

Access plugin settings at Settings > EZCONTACTFORM in WordPress admin.

Basic Settings

  • Default Form ID - Your EZCONTACTFORM form ID (create one at www.ezcontactform.com)
  • Widget Version - Use latest or pin to specific version
  • Default Theme - system, light, or dark
  • Default Display Mode - inline or button
  • Default Button Text - Text for button mode

Advanced Settings

  • Debug Mode - Enable browser console logging
  • Custom CSS - Disable default styles (use your own)
  • Widget CDN URL - Override default CDN (advanced users)

Development

Local Development Setup

This plugin uses Docker for local WordPress development.

# Clone the repository
git clone https://github.com/ezcontactform/wordpress.git
cd wordpress

# Start WordPress with Docker
docker-compose up -d

# Access WordPress
# Site: http://localhost:8888
# Admin: http://localhost:8888/wp-admin

Project Structure

ezcontactform-wordpress/
├── ezcontactform/              # Plugin directory
│   ├── ezcontactform.php       # Main plugin file
│   ├── readme.txt              # WordPress.org readme
│   ├── includes/               # PHP classes
│   │   ├── class-ezcontactform-admin.php
│   │   ├── class-ezcontactform-block.php
│   │   └── class-ezcontactform-shortcode.php
│   ├── blocks/                 # Gutenberg blocks
│   │   └── ezcontactform-block/
│   ├── assets/                 # CSS, JS, images
│   └── languages/              # Translation files
├── docker-compose.yml          # Docker configuration
└── README.md                   # This file

Building for Production

The plugin is ready to use as-is. For distribution:

# Create a ZIP file
cd ezcontactform-wordpress
zip -r ezcontactform.zip ezcontactform/ -x "*/.*" "*/node_modules/*"

Frequently Asked Questions

Where do I get a Form ID?

You must create an account at www.ezcontactform.com to get a Form ID.

  1. Sign up for free
  2. Create a new form in the dashboard
  3. Copy your Form ID (also called Source ID)
  4. Use it in the WordPress plugin

Without a Form ID, the plugin cannot display forms.

Can I have multiple forms on one page?

Yes! Add multiple shortcodes or blocks with different Form IDs.

Does this work with my theme?

Yes, the plugin works with any properly coded WordPress theme.

Is this plugin free?

Yes, the WordPress plugin is free. EZCONTACTFORM offers both free and paid plans. Visit www.ezcontactform.com/pricing for details.

Where are form submissions stored?

Form submissions are stored securely on EZCONTACTFORM servers and accessible via your dashboard at www.ezcontactform.com.

Can I customize the form appearance?

Yes! Customize forms in your EZCONTACTFORM dashboard. The WordPress plugin provides theme options and display modes.

Does this require coding knowledge?

No! Simply use the Gutenberg block or copy/paste the shortcode.

Support

Contributing

Contributions are welcome! Please read CONTRIBUTING.md for details.

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Changelog

See CHANGELOG.md for release history.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Credits

Made with ❤️ by the EZCONTACTFORM team.


Need help? Visit www.ezcontactform.com/support

About

EZCONTACTFORM makes it easy to capture customer information and react. This project is the source code of our wordpress plugin. Configuration is driven by www.ezcontactform.com.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors