| <?php | |
| /** | |
| * Gravity Wiz // Gravity Forms // Time Sensitive Choices | |
| * | |
| * Provide a drop down of times and automatically filter which choices are available based on the current time. | |
| * | |
| * @version 0.1 | |
| * @author David Smith <david@gravitywiz.com> | |
| * @license GPL-2.0+ | |
| * @link http://gravitywiz.com/... | |
| * @copyright 2015 Gravity Wiz | |
| * | |
| * # WordPress Plugin Header | |
| * | |
| * Plugin Name: Gravity Forms Time Sensitive Choices | |
| * Plugin URI: http://ounceoftalent.com | |
| * Description: Provide a drop down of times and automatically filter which choices are avialable based on the current time. | |
| * Author: David Smith | |
| * Version: 0.1 | |
| * Author URI: http://ounceoftalent.com | |
| * | |
| */ | |
| class GW_Time_Sensitive_Choices { | |
| 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_ids' => array(), | |
| 'time_mod' => 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_pre_render', array( $this, 'filter_form_by_time' ) ); | |
| } | |
| public function filter_form_by_time( $form ) { | |
| if( ! $this->is_applicable_form( $form ) ) { | |
| return $form; | |
| } | |
| foreach( $form['fields'] as &$field ) { | |
| if( $this->is_applicable_field( $field ) ) { | |
| $field->choices = $this->filter_choices_by_time( $field->choices ); | |
| } | |
| } | |
| return $form; | |
| } | |
| public function filter_choices_by_time( $choices ) { | |
| $filtered_choices = array(); | |
| $current_time = current_time( 'timestamp' ); | |
| $max_time = strtotime( '23:59', $current_time ); | |
| $time_cutoff = strtotime( $this->_args['time_mod'], $current_time ); | |
| if( $time_cutoff > $max_time ) { | |
| $time_cutoff = $max_time; | |
| } | |
| foreach( $choices as $choice ) { | |
| $time = strtotime( $choice['value'], $current_time ); | |
| if( $time > $time_cutoff ) { | |
| $filtered_choices[] = $choice; | |
| } | |
| } | |
| return $filtered_choices; | |
| } | |
| public function is_applicable_form( $form ) { | |
| return $this->_args['form_id'] == $form['id']; | |
| } | |
| public function is_applicable_field( $field ) { | |
| return in_array( $field->id, $this->_args['field_ids'] ); | |
| } | |
| } | |
| # Configuration | |
| new GW_Time_Sensitive_Choices( array( | |
| 'form_id' => 964, | |
| 'field_ids' => array( 10, 12, 13 ), | |
| 'time_mod' => '+1 hours' | |
| ) ); |
Overview
If you’ve ever built a form for scheduling, you know how important it is that the available times are accurate. Use this snippet to automatically limit the choices based on the current time.
Using the Snippet
Prerequisites
Confirm that you have Gravity Forms installed and activated and that you’ve installed the snippet.
Add a Choice Field
With the snippet installed, add a Drop Down or Radio Button field to your form and set the choices to the different times you want to make available.
The snippet expects the times to be specific and in plain English. For example, all of these are acceptable:
- 1pm
- 1:00pm
- 1:00 p.m.
- 13:00
This is not acceptable:
1:00 pm – 2:00 pm
Update Snippet with Parameters
Update the form_id and field_ids in the snippet to match your Form ID and the Field IDs for your Drop Down or Radio Button fields from above. Set the time_mod to adjust the minimum time available using PHP Relative Format.
| new GW_Time_Sensitive_Choices( array( | |
| 'form_id' => 964, | |
| 'field_ids' => array( 10, 12, 13 ), | |
| 'time_mod' => '+1 hours' | |
| ) ); |
The time_mod parameter tells the snippet how far ahead to limit choices based on the current time. For example, if you want at least a two hour lead time on appointments, you would set the time_mod parameter to +2 hours.
time_mod to +0 hoursParameters
- form_id (integer) (required) This is the Form ID that contains your time sensitive choices. There is no default value.
- field_ids (array) (required) This is the Field ID for the field where the choices are stored. There is no default value.
- time_mod (string) (required) Sets how far ahead to limit choices relative to the current time in PHP relative format. There is no default value.
Taking It Further
Since a time sensitive choice-based field is going to automatically remove past times from the available choices, if your form is used to schedule any day in the future, you’ll need to be selective when you show this field.
GF Conditional Logic Dates makes it easy to automatically show this field only when appropriate. Here’s how to set that up:
 | Add a Date field to the form and insert the {date_mdy} merge tag into its Default Value. |
 | Duplicate your choice-based time field. Do not apply the snippet to the duplicated field. |
 | Use Conditional Logic to show the time sensitive field when the selected Date is today. |
 | Set up Conditional Logic to show the duplicated field when the selected Date is not today. |
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.
Leave a Reply