| <?php | |
| /** | |
| * Gravity Wiz // Gravity Forms // Cache Buster | |
| * | |
| * Bypass your website cache when loading a Gravity Forms form. | |
| * | |
| * @version 0.2 | |
| * @author David Smith <david@gravitywiz.com> | |
| * @license GPL-2.0+ | |
| * @link http://gravitywiz.com/ | |
| * | |
| * Plugin Name: Gravity Forms Cache Buster | |
| * Plugin URI: http://gravitywiz.com/ | |
| * Description: Bypass your website cache when loading a Gravity Forms form. | |
| * Author: Gravity Wiz | |
| * Version: 0.2 | |
| * Author URI: http://gravitywiz.com | |
| * | |
| * @todo | |
| * - Pass query string to AJAX form. | |
| */ | |
| class GW_Cache_Buster { | |
| public function __construct( $args = array() ) { | |
| // set our default arguments, parse against the provided arguments, and store for use throughout the class | |
| $this->_args = wp_parse_args( $args, array( | |
| 'form_id' => false, | |
| 'field_id' => false | |
| ) ); | |
| // do version check in the init to make sure if GF is going to be loaded, it is already loaded | |
| add_action( 'init', array( $this, 'init' ) ); | |
| } | |
| public function init() { | |
| // make sure we're running the required minimum version of Gravity Forms | |
| if( ! property_exists( 'GFCommon', 'version' ) || ! version_compare( GFCommon::$version, '1.8', '>=' ) ) { | |
| return; | |
| } | |
| add_filter( 'gform_shortcode_form', array( $this, 'shortcode' ), 10, 3 ); | |
| add_action( 'wp_ajax_nopriv_gfcb_get_form', array( $this, 'ajax_get_form' ) ); | |
| add_action( 'wp_ajax_gfcb_get_form', array( $this, 'ajax_get_form' ) ); | |
| } | |
| public function shortcode( $markup, $attributes, $content ) { | |
| $atts = shortcode_atts( array( | |
| 'id' => 0, | |
| 'cachebuster' => false | |
| ), $attributes ); | |
| $form_id = $atts['id']; | |
| if( ! $this->is_cache_busting_applicable() ) { | |
| return $markup; | |
| } | |
| $is_enabled = rgar( $atts, 'cachebuster' ) || gf_apply_filters( array( 'gfcb_enable_cache_buster', $form_id ), false ); | |
| if( ! $is_enabled ) { | |
| return $markup; | |
| } | |
| ob_start(); | |
| ?> | |
| <div id="gf-cache-buster-form-container-<?php echo $form_id; ?>" class="gf-cache-buster-form-container"> | |
| <div class="loader"></div> | |
| <style type="text/css"> | |
| .gf-cache-buster-form-container { } | |
| .loader, | |
| .loader:before, | |
| .loader:after { | |
| border-radius: 50%; | |
| width: 2.5em; | |
| height: 2.5em; | |
| -webkit-animation-fill-mode: both; | |
| animation-fill-mode: both; | |
| -webkit-animation: load7 1.8s infinite ease-in-out; | |
| animation: load7 1.8s infinite ease-in-out; | |
| } | |
| .loader { | |
| color: rgba( 0, 0, 0, 0.5 ); | |
| font-size: 10px; | |
| margin: 0 auto 80px; | |
| position: relative; | |
| text-indent: -9999em; | |
| -webkit-transform: translateZ(0); | |
| -ms-transform: translateZ(0); | |
| transform: translateZ(0); | |
| -webkit-animation-delay: -0.16s; | |
| animation-delay: -0.16s; | |
| } | |
| .loader:before, | |
| .loader:after { | |
| content: ''; | |
| position: absolute; | |
| top: 0; | |
| } | |
| .loader:before { | |
| left: -3.5em; | |
| -webkit-animation-delay: -0.32s; | |
| animation-delay: -0.32s; | |
| } | |
| .loader:after { | |
| left: 3.5em; | |
| } | |
| @-webkit-keyframes load7 { | |
| 0%, | |
| 80%, | |
| 100% { | |
| box-shadow: 0 2.5em 0 -1.3em; | |
| } | |
| 40% { | |
| box-shadow: 0 2.5em 0 0; | |
| } | |
| } | |
| @keyframes load7 { | |
| 0%, | |
| 80%, | |
| 100% { | |
| box-shadow: 0 2.5em 0 -1.3em; | |
| } | |
| 40% { | |
| box-shadow: 0 2.5em 0 0; | |
| } | |
| } | |
| </style> | |
| </div> | |
| <script type="text/javascript"> | |
| ( function ( $ ) { | |
| $.post( '<?php echo admin_url( 'admin-ajax.php' ); ?>?action=gfcb_get_form&form_id=<?php echo $form_id; ?>', { | |
| action: 'gfcb_get_form', | |
| form_id: '<?php echo $form_id; ?>', | |
| atts: '<?php echo json_encode( $attributes ); ?>' | |
| }, function( response ) { | |
| $( '#gf-cache-buster-form-container-<?php echo $form_id; ?>' ).html( response ).fadeIn(); | |
| if( window['gformInitDatepicker'] ) { | |
| gformInitDatepicker(); | |
| } | |
| } ); | |
| } ( jQuery ) ); | |
| </script> | |
| <?php | |
| return ob_get_clean(); | |
| } | |
| public function is_cache_busting_applicable() { | |
| // POSTED and LOGGED-IN requests are not typically cached | |
| return empty( $_POST ) || ! is_user_logged_in(); | |
| } | |
| public function ajax_get_form() { | |
| $form_id = isset( $_POST['form_id'] ) ? absint( $_POST['form_id'] ) : 0; | |
| if( ! $form_id ) { | |
| $form_id = isset( $_GET['form_id'] ) ? absint( $_GET['form_id'] ) : 0; | |
| } | |
| $atts = json_decode( rgpost( 'atts' ) ); | |
| gravity_form( $form_id, rgar( $atts, 'title' ), rgar( $atts, 'description' ), false, rgar( $atts, 'field_values' ), true /* default to true; add support for non-ajax in the future */, rgar( $atts, 'tabindex' ) ); | |
| die(); | |
| } | |
| } | |
| # Configuration | |
| new GW_Cache_Buster(); | |
| //add_filter( 'gfcb_enable_cache_buster', '__return_true' ); |
Overview
I think if there’s one thing everyone in the WordPress community agrees on, it’s this: caching is awesome. It improves the performance of your site and reduces the bandwidth required to load pages and files. WordPress-specific hosting providers typically cache pages by default, and if you’re managing your own server you can add any number of plugins, such as WP Super Cache, W3 Total Cache, and many more that can immediately improve page load times. If you aren’t taking advantage of caching on your site, you should.
If you use caching on your site, you should know that it can sometimes cause unexpected side effects with Gravity Forms. This can be further compounded when using our Perks, like Populate Anything, Nested Forms, and Limit Choices. To avoid this, it is recommended to bypass the cache on Gravity Forms with dynamic features.
One solution for this is to simply exclude those pages from the cache, but you lose the benefits of page caching. A better solution is to only bypass the cache for the form itself, and we cooked up a Cache Buster plugin to do just that.
It loads the form via AJAX (not to be confused with submitting the form via AJAX), bypassing the WordPress cache for the form only. This allows the page cache, and the performance boost that goes with it, to remain intact.
Using the Plugin
Prerequisites
Confirm that you have Gravity Forms installed and activated and that you’ve installed and activated the plugin.
Using the Shortcode
When adding a form to a post or page via the [gravityforms] shortcode, simply add the “cachebuster” parameter:
[gravityforms id="123" cachebuster="1"]The form will then load via AJAX , bypassing the WordPress cache.
Apply to All Forms
If you would rather apply the Cache Buster to every form on the page, you can do so by adding the following line to your theme’s functions.php file.
add_filter( 'gfcb_enable_cache_buster', '__return_true' );The Cache Buster will now automatically apply to every form on your site.
Known Limitations
Cache Buster does not work with single File Upload fields due to browser security. It does work with Multi-file Upload fields since they upload via AJAX.
Fresh Forms for Gravity
Another solution for automatically bypassing the cache is Fresh Forms for Gravity. It supports most of the caching plugins out there and requires no setup. Simply install it and your forms will be excluded from the cache.
Did this resource help you do something awesome with Gravity Forms? Then you'll absolutely love Gravity Perks; a suite of 31+ essential add-ons for Gravity Forms with support you can count on.
Work Well! Just not working with a {embed_url} conformation redirect, it results in a blank page. Any workaround?
Thanks
Right, I’m aware of that, but are there some minimum requirements for PHP, for example, for this to be effective?
Hi Scot,
I just ran a version check, and this plugin shows no issues with PHP 5.6 or greater.
Are there any minimum requirements for this plugin, much like those listed for Fresh Forms?
Hey Scot, Please just confirm that you have Gravity Forms installed and activated and that you’ve installed and activated the plugin or cache buster code listed above.😃