April 21, 2023

Modal Dialog Plugin

The purpose of this plugin is to allow users to create one or more modal dialog(s) / pop-up window(s) that will appear when a user visits their site.

The purpose of this plugin is to allow users to create one or more modal dialog(s) / pop-up window(s) that will appear when a user visits their site. The number of times that these can load is configurable. They can load content from external sites or custom HTML code into the dialog. This plugin can be used to invite people to register to a newsletter, respond to a survey, or simply welcome come to a site upon their first visit.

You can try it out in a temporary copy of WordPress here.

Installation

Download the plugin and unzip it.
Upload the modal-dialog folder to the /wp-content/plugins/ directory of your web site.
Activate the plugin in the WordPress Admin.
Using the Configuration Panel for the plugin, configure as desired
Dialogs can also be assigned to posts/pages within the editor

FAQ

Why is Modal Dialog not showing up on my web site?

There are typically two main reasons why Modal Dialog does not show up correctly on web pages:

1- You have another plugin installed which uses jQuery on your site that has its own version of jQuery instead of using the default version that is part of the WordPress install. To see if this is the case, go to your site and look at the page source, then search for jQuery. If you see some versions of jQuery that get loaded from plugin directories, then this is most likely the source of the problem as they would conflict with the jQuery 1.3.2 that is delivered with WordPress.

2- The other thing to check is to see if your theme has the wp_head and wp_footer functions in the theme’s header. If these functions are not present, then the plugin will not work as expected.

You can send me a link to your web site if these solutions don’t help you so that I can see what is happening myself and try to provide a solution.

How can I close the Modal Dialog Window Manually?

You can create a button or other control that calls the following javascript:

parent.jQuery.fancybox.close();

How can I manually set the cookie if I ask Modal Dialog to let me do it manually?

Call the following javascript / jQuery function, setting the cookie-name to match the name entered in the Modal Dialog settings, the cookievalue and the duration to any duration that you deem acceptable.

jQuery.cookie(‘cookie-name’, cookievalue, { expires: 365 });

Changelog

3.5.15

Corrections for potential security issues

3.5.14

Further fixes when saving HTML dialog contents

3.5.12

Fixed problems saving HTML dialog contents

3.5.11

Fix PHP error in admin pages

3.5.10

Additional corrections for potential security issues

3.5.9

Corrected potential security issue

3.5.8

Fixed display bug when multiple libraries are configured
Added info on cookies in FAQ section

3.5.7

Fix bug with Fancybox not working with jQuery provided in newest versions of WordPress

3.5.6

Changed plugin so modal dialog is inactive until a user activates it

3.5.5

Correction to avoid having modal dialog appear on wrong pages when multiple configurations are present

3.5.4

Update for PHP 7.0 compatibility

3.5.3

Fix bug with duration not being used since previous update

3.5.2

Fix to avoid javascript error if user leaves delay field empty

3.5.1

Fix to make sure that jQuery is loaded

3.5

Moved mobile browser detection client-side using Javascript

3.4.3

Fix to accept quote in PHP Condition String

3.4.2

Add ability to add PHP condition string to specify pages where dialog will appear

3.4.1

Reverting all changes from version 3.4

3.3

Added two new functions to change content of Modal Dialog through javascript code: set_modal_dialog_content( newContent ) and set_modal_dialog_web_site_address( newAddress )
Changed some of the default values for the plugin for new installations

3.2.4

Added option to specify if dialog should appear on registration page

3.2.3

Added further variable initialization to avoid PHP warnings

3.2.2

Removal of unnecessary check in colorbox display code

3.2.1

Fixed problem with plugin activation introduced in version 3.2

3.2

Re-arranged admin panel in multiple sections of related settings
Fixed to display logic when multiple dialogs are present
New configuration to suppress display by URL name

3.1.1

Added new option to control transition mode

3.1

Changed code to only increment cookie values when the dialog actually appears
Added new options to be able to specify dialog position when using Colorbox library

3.0.9

Added new option to allow admin to give access to other user levels to the Modal Dialog configuration dialog

3.0.8

Fix to support plugins installed in directory other than default

3.0.7

Small update to allow width and height to be specified in percentages

3.0.6

Corrected issue with new mobile detection library

3.0.5

Updated Mobile Detect library

3.0.4

Set default active value to false for multisite installations

3.0.3

Fix issue with page jump on dialog exit in some browsers

3.0.2

Added new option to ignore esc key to close the dialog

3.0.1

Fix PHP warnings

3.0

New FAQ section
New utility functions to open and close the dialog through javascript code (modal_dialog_open() and modal_dialog_close())
Restored support for Contact Form 7
Included new pop-up script (colorbox)
Option to revert back to legacy fancybox pop-up script (Under Modal Dialog General Settings)
Fixes problem with pop-up content going away if opened multiple times (in colorbox mode)

2.5.1

Reverted to version 2.4.9 code since fancybox2 is not compliant with WP licensing terms. Will work on a new version to reintroduce 2.5 functionality.

2.5

Upgrade of pop-up script to fancybox2
Fixes problem with pop-up content going away if opened multiple times
Adds support for Contact Form 7

2.4.9

Updated code to support web site running on SSL connections

2.4.8

Renamed Mobile Detect library to make name unique and avoid conflicts with other plugins using the same library

2.4.7

Modified a few option checks to make sure that dialog works even if some options are missing

2.4.6

Correct problem with update redirecting to github page

2.4.5

Bringing back changes from 2.4.3

2.4.4

Rolled back changes from 2.4.3

2.4.3

Forcing close button to appear when it is intended to be displayed

2.4.2

Changed to new mobile browser detection library that is more frequently updated

2.4.1

Updated mobile browser detection library

2.4

Re-wrote dialog display decision code to be cleaner
Upgraded fancybox to version 1.3.4

2.3.9

Changed Show on front page option to control display on front page whether or not the “Only show on specific pages and single posts”

2.3.8

Added option field to specify pages where the dialog should NOT be shown

2.3.7

Fixed “Delete all cookies” button on admin page

2.3.6

Fixed compatibility issue with WP 3.4 related to jQuery queuing call

2.3.5

Second fix to display logic count when selecting a display period and a maximum number of displays

2.3.4

Fixed display count logic

2.3.3

Added new option to force hiding of the scroll bars

2.3.2

Second fix to IE 7 check

2.3.1

Fixed display logic code
Small correction to IE 7 if check for W3C validation

2.3

Added option to disable modal dialog on mobile browsers

2.2.5

Corrected problem with Activate option not working correctly

2.2.4

Added mechanism to register callback function to be called when the Modal Dialog is closed

2.2.3

Added option to display modal dialog when a new comment is posted (as a thank you note)

2.2.2

Added call to do_shortcode on dialogtext so that shortcodes can be inserted and processed for the content

2.2.1

Fixed issue with Modal Dialog not showing up after upgrading

2.2

Added option to only display dialog every X number of times that page is reloaded
Added option to not display dialog to users that are logged on to site

2.1.1

Updated version of jQuery Cookies script to try and resolve a problem with Chrome on PC

2.1

Changed IE-specific code only to display in IE7 or older
Tested against WordPress 3.2

2.0.6

Renamed jQuery.cookie.js to cookie.js to resolve a user issue

2.0.5

Declared global variable to hold plugin class to allow for external calls

2.0.4

Added back modal_dialog_init function. Should be called as $modal_dialog_init. No argument anymore.

2.0.3

Fixed error in Screen Options tab
Fixed admin page layout

2.0.2

Restored Manual Display option when calling Modal Dialog functions manually

2.0.1

Fixed internal error problem that appeared in version 2.0 on some systems

2.0

Adds ability to define multiple modal dialogs
Adds ability of assigning a modal dialog to a post/page in editor

1.2.3

Added button to easily delete all cookies for a site from admin panel to facilitate testing

1.2.2

Fixed code to get Modal Dialog only to show on specific pages or posts

1.2.1

Added ability to display Modal Dialog on specific single post pages

1.2

Tested for WordPress 3.1 Compatibility

1.1.9

Added call to reset query mechanism so that Modal Dialog properly writes code to page footer

1.1.8

Renamed installation function to avoid conflicts with plugin Mobile Detector

1.1.7

Added option to auto-close dialog after a user-defined period (set in milliseconds)

1.1.6

Made cookies global to the site instead of specific to a page

1.1.5

Added new option to control overlay opacity

1.1.4

Extended manual cookie creation to session cookies that control only showing the dialog once per session

1.1.3

Added option to tell Modal Dialog that you will manually set the cookie manually after the dialog is displayed

1.1.2

Added parameters to API calls to allow user to call on specific page templates

1.1.1

Added option to only show modal dialog once on a site per browser session
Added option to keep modal dialog centered on page when user scrolls
Added option to hide close button to allow user to control dialog closing through code

1.1

Added option to force user the specification of pages on which Modal Dialog should be displayed
Added option to display Modal Dialog on front page

1.0.9

Removed border color option to avoid conflicts with other plugins using fancybox

1.0.8

Changed way that background color and text color are applied to avoid conflicts with other plugins using fancybox

1.0.7

Prevent modal-dialog code from executing when viewing admin pages to avoid conflicts with admin page scripts

1.0.6

Fixed: Background Color and Text Color now work as expected
Added: Border Color Option

1.0.5

Fixed: Images (border / close icon) not showing up correctly in Internet Explorer
Fixed: Dialog Width and Height configuration parameters were ignored

1.0.4

Removed unnecessary debug statement

1.0.3

Fixed: Removed reference to missing function to change plugin icon

1.0.2

Corrected problem with special HTML characters getting stripped out of dialog content when specifying in text box.
Added option to auto-resize dialog

1.0.1

Upgraded fancybox plugin to latest version
Added option to specify number of times to display dialog
Added option to specify how modal dialog can be closed.

1.0

First release