gpi-populate-days.php: Added new snippet.
#1155
Conversation
WalkthroughAdds a new Gravity Forms snippet that populates a radio field (form 123, field 1) with the next N weekly dates and per-day inventory, using configurable weekday, cutoff day/time, count, inventory limit, and date format; hooks into pre-render and pre-validation with a one-time-per-page guard. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor User
participant GF as Gravity Forms (Form 123)
participant Plugin as gw_populate_days_into_radio
User->>GF: Load form / Submit (pre-render / pre-validation)
GF->>Plugin: Invoke hook (gform_pre_render_123 / gform_pre_validation_123)
rect rgb(238,246,255)
Note over Plugin: static guard ensures single run per page
Plugin->>Plugin: Determine start date (this <weekday>)
alt Cutoff applies (weekday/time past cutoff)
Plugin->>Plugin: Advance start by 1 week (skip this week's date)
end
loop generate choices (1..number_of_days)
Plugin->>Plugin: date_i = start + (i-1) weeks
Plugin->>Plugin: Build choice {text/value = formatted date, inventory_limit}
end
Plugin-->>GF: Return modified form with populated radio choices
end
GF-->>User: Render/Validate form with populated choices
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (3)
gp-inventory/gpi-populate-days.php (3)
70-76: Cast inventory to int and keep array stable.Small hardening: ensure an integer limit is set.
- $label = $start_day->format( $format ); + $label = $start_day->format( $format ); $choices[] = array( 'text' => $label, - 'value' => $label, - 'inventory_limit' => $inventory, + 'value' => $label, + 'inventory_limit' => (int) $inventory, );Note: inventory_limit is the correct choice key GP Inventory reads. (gravitywiz.com)
50-55: Scope the “run once” guard by form ID.Safer if this snippet is expanded to more forms; avoids blocking population for other forms in the same request.
- static $has_run = false; - if ( $has_run ) { - return $form; - } - $has_run = true; + static $has_run = array(); + if ( ! empty( $has_run[ $form['id'] ] ) ) { + return $form; + } + $has_run[ $form['id'] ] = true;
21-23: Hooks look good; consider covering admin and submission paths too.Pre-render and pre-validation are correct. Optionally add gform_pre_submission_filter_123 and gform_admin_pre_render_123 for parity across AJAX submissions and admin UI.
add_filter( 'gform_pre_render_123', 'gw_populate_days_into_radio', 5, 1 ); add_filter( 'gform_pre_validation_123', 'gw_populate_days_into_radio', 5, 1 ); +add_filter( 'gform_pre_submission_filter_123', 'gw_populate_days_into_radio', 5, 1 ); +add_filter( 'gform_admin_pre_render_123', 'gw_populate_days_into_radio', 5, 1 );
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled
- Linear integration is disabled
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
gp-inventory/gpi-populate-days.php(1 hunks)
🧰 Additional context used
🪛 GitHub Check: PHPCS (Files Changed)
gp-inventory/gpi-populate-days.php
[warning] 73-73:
Array double arrow not aligned correctly; expected 11 space(s) between "'value'" and double arrow, but found 1.
[warning] 72-72:
Array double arrow not aligned correctly; expected 12 space(s) between "'text'" and double arrow, but found 1.
[warning] 70-70:
Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space
[failure] 64-64:
Expected 1 spaces after opening parenthesis; 0 found
[failure] 64-64:
Expected 1 spaces before closing parenthesis; 0 found
[failure] 64-64:
Expected 1 spaces after opening parenthesis; 0 found
[failure] 64-64:
Expected 1 space(s) after cast statement; 0 found
[failure] 64-64:
Expected 1 spaces before closing parenthesis; 0 found
[failure] 64-64:
Expected 1 spaces after opening parenthesis; 0 found
[warning] 60-60:
Equals sign not aligned with surrounding assignments; expected 5 spaces but found 3 spaces
[warning] 59-59:
Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space
[failure] 47-47:
Whitespace found at end of line
[failure] 15-15:
Whitespace found at end of line
[failure] 13-13:
Whitespace found at end of line
[failure] 5-5:
Whitespace found at end of line
🪛 GitHub Actions: PHP Lint (PR)
gp-inventory/gpi-populate-days.php
[error] 5-5: PHPCS (step: Run thenabeel/action-phpcs@v8): Whitespace found at end of line (Squiz.WhiteSpace.SuperfluousWhitespace.EndLine).
🔇 Additional comments (2)
gp-inventory/gpi-populate-days.php (2)
56-58: Field targeting and type check are correct.Good guard; prevents accidental population of other fields.
68-79: Choice generation loop is solid.Correct count, step, and weekly increment.
gp-inventory/gpi-populate-days.php
Outdated
| $choices = array(); | ||
| $today = new DateTime(); | ||
| $start_day = new DateTime( 'this ' . $day ); | ||
|
|
||
| // If it's past the cutoff, also skip this week's day |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Use the WordPress timezone to avoid server/WP offset drift.
Gravity Forms/WordPress operate in the site timezone; default DateTime() may use server TZ. Initialize with wp_timezone() for consistency.
- $choices = array();
- $today = new DateTime();
- $start_day = new DateTime( 'this ' . $day );
+ $choices = array();
+ $tz = function_exists( 'wp_timezone' ) ? wp_timezone() : null;
+ $today = new DateTime( 'now', $tz );
+ $start_day = new DateTime( 'this ' . $day, $tz );📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| $choices = array(); | |
| $today = new DateTime(); | |
| $start_day = new DateTime( 'this ' . $day ); | |
| // If it's past the cutoff, also skip this week's day | |
| $choices = array(); | |
| $tz = function_exists( 'wp_timezone' ) ? wp_timezone() : null; | |
| $today = new DateTime( 'now', $tz ); | |
| $start_day = new DateTime( 'this ' . $day, $tz ); | |
| // If it's past the cutoff, also skip this week's day |
🧰 Tools
🪛 GitHub Check: PHPCS (Files Changed)
[warning] 60-60:
Equals sign not aligned with surrounding assignments; expected 5 spaces but found 3 spaces
[warning] 59-59:
Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space
🤖 Prompt for AI Agents
In gp-inventory/gpi-populate-days.php around lines 59 to 63, the DateTime
instances are created without specifying the WordPress timezone causing
potential server vs WP timezone drift; change the DateTime creation to use
wp_timezone() so both $today and $start_day are initialized with the site
timezone (i.e., construct them using the WordPress timezone object returned by
wp_timezone()) to ensure consistent date calculations.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (3)
gp-inventory/gpi-populate-days.php (3)
63-67: Fix cutoff logic, block past-date inclusion, and satisfy PHPCS on Line 64.Current condition can surface a past day and fails PHPCS. Replace with guarded, readable logic.
- // If it's past the cutoff, also skip this week's day - if ( ( $today->format('N') == $cutoff_day && ( int )$today->format('H') >= $cutoff_time ) || $today->format('N') > $cutoff_day && $today->format('N') <= $start_day->format('N') ) { - $start_day->modify('+1 week'); - } + // Ensure start day is not in the past; then apply cutoff. + $midnight = ( clone $today )->setTime( 0, 0, 0 ); + if ( $start_day < $midnight ) { + $start_day->modify( 'next ' . $day ); + } else { + $today_dow = (int) $today->format( 'N' ); + $today_hour = (int) $today->format( 'H' ); + $target_dow = (int) $start_day->format( 'N' ); + if ( + ( $today_dow === (int) $cutoff_day && $today_hour >= (int) $cutoff_time ) + || ( $today_dow > (int) $cutoff_day && $today_dow <= $target_dow ) + ) { + $start_day->modify( '+1 week' ); + } + }
59-63: Initialize dates with the WordPress timezone.Prevents server/WP offset drift; also improves determinism around cutoff.
- $choices = array(); - $today = new DateTime(); - $start_day = new DateTime( 'this ' . $day ); + $choices = array(); + $tz = function_exists( 'wp_timezone' ) ? wp_timezone() : null; + $today = new DateTime( 'now', $tz ); + $start_day = new DateTime( 'this ' . $day, $tz );
5-5: Remove trailing whitespace to unblock PHPCS.These lines still flag Squiz.WhiteSpace.SuperfluousWhitespace.EndLine.
- * + * - * + * - * + * - // That's it, stop editing! + // That's it, stop editing!Also applies to: 13-13, 15-15, 47-47
🧹 Nitpick comments (2)
gp-inventory/gpi-populate-days.php (2)
57-58: Tighten comparisons and follow WP style.Use strict compare and Yoda for the string compare.
- if ( $field->id == $field_id && $field->type == 'radio' ) { + if ( (int) $field->id === (int) $field_id && 'radio' === $field->type ) {
69-77: Remove trailing whitespace and apply spacing/cast adjustments
- Remove trailing space on line 71 after
array(- Align assignments:
$label = $start_day->format( $format );$choices[] = array(- Cast inventory:
'inventory_limit' => (int) $inventory,- Add spaces in method call:
$start_day->modify( '+1 week' );- Ensure PHPCS is configured with the PHPCompatibilityWP sniff to verify style compliance
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled
- Linear integration is disabled
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
gp-inventory/gpi-populate-days.php(1 hunks)
🧰 Additional context used
🪛 GitHub Check: PHPCS (Files Changed)
gp-inventory/gpi-populate-days.php
[warning] 70-70:
Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space
[failure] 64-64:
Expected 1 spaces before closing parenthesis; 0 found
[failure] 64-64:
Expected 1 spaces after opening parenthesis; 0 found
[failure] 64-64:
Expected 1 spaces before closing parenthesis; 0 found
[failure] 64-64:
Expected 1 spaces after opening parenthesis; 0 found
[failure] 64-64:
Expected 1 spaces before closing parenthesis; 0 found
[failure] 64-64:
Expected 1 spaces after opening parenthesis; 0 found
[failure] 64-64:
Cast statements must not contain whitespace; expected "(int)" but found "( int )"
[failure] 64-64:
Expected 1 space(s) after cast statement; 0 found
[failure] 64-64:
Expected 1 spaces before closing parenthesis; 0 found
[failure] 64-64:
Expected 1 spaces after opening parenthesis; 0 found
🪛 GitHub Actions: PHP Lint (PR)
gp-inventory/gpi-populate-days.php
[error] 64-64: PHPCS: PEAR.Functions.FunctionCallSignature.SpaceAfterOpenBracket - Expected 1 spaces after opening parenthesis; 0 found.
🔇 Additional comments (1)
gp-inventory/gpi-populate-days.php (1)
50-55: Idempotency guard looks good.Prevents double-population across pre-render and pre-validation.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
gp-inventory/gpi-populate-days.php (2)
63-66: Fix cutoff logic (prevents past-date inclusion) and satisfy PHPCS.On Fri–Sun,
this thursdaycan be in the past and still be included. Replace the block to guard against past dates and keep the cutoff behavior; also conforms to spacing rules.- // If it's past the cutoff, also skip this week's day - if ( ( $today->format( 'N' ) == $cutoff_day && ( int )$today->format( 'H' ) >= $cutoff_time ) || $today->format( 'N' ) > $cutoff_day && $today->format( 'N' ) <= $start_day->format( 'N' ) ) { - $start_day->modify( '+1 week' ); - } + // If the target day this week has already passed, skip to next week first. + $midnight = ( clone $today )->setTime( 0, 0, 0 ); + if ( $start_day < $midnight ) { + $start_day->modify( 'next ' . $day ); + } else { + // If it's past the cutoff, also skip this week's day. + $today_dow = (int) $today->format( 'N' ); + $target_dow = (int) $start_day->format( 'N' ); + if ( + ( $today_dow === (int) $cutoff_day && (int) $today->format( 'H' ) >= (int) $cutoff_time ) + || ( $today_dow > (int) $cutoff_day && $today_dow <= $target_dow ) + ) { + $start_day->modify( '+1 week' ); + } + }
59-62: Use WordPress timezone to avoid server/WP drift.Initialize DateTime with
wp_timezone(); fall back to site TZ or UTC.- $choices = array(); - $today = new DateTime(); - $start_day = new DateTime( 'this ' . $day ); + $choices = array(); + $tz = function_exists( 'wp_timezone' ) ? wp_timezone() : new DateTimeZone( get_option( 'timezone_string' ) ?: 'UTC' ); + $today = new DateTime( 'now', $tz ); + $start_day = new DateTime( 'this ' . $day, $tz );
🧹 Nitpick comments (2)
gp-inventory/gpi-populate-days.php (2)
71-75: Ensure inventory is an integer.Cast to int to avoid accidental strings.
- 'inventory_limit' => $inventory, + 'inventory_limit' => (int) $inventory,
68-75: Optional: Localize date labels.Use
wp_date()for i18n while keepingDateTimefor calculations.- $label = $start_day->format( $format ); + $label = function_exists( 'wp_date' ) ? wp_date( $format, $start_day->getTimestamp() ) : $start_day->format( $format );
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled
- Linear integration is disabled
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
gp-inventory/gpi-populate-days.php(1 hunks)
🧰 Additional context used
🪛 GitHub Check: PHPCS (Files Changed)
gp-inventory/gpi-populate-days.php
[failure] 76-76:
Expected 1 spaces before closing parenthesis; 0 found
[failure] 76-76:
Expected 1 spaces after opening parenthesis; 0 found
[failure] 71-71:
Whitespace found at end of line
[failure] 64-64:
Cast statements must not contain whitespace; expected "(int)" but found "( int )"
[failure] 64-64:
Expected 1 space(s) after cast statement; 0 found
🪛 GitHub Actions: PHP Lint (PR)
gp-inventory/gpi-populate-days.php
[error] 64-64: PHPCS (thenabeel/action-phpcs@v8): Expected 1 space(s) after cast statement; 0 found. (Generic.Formatting.SpaceAfterCast.NoSpace)
🔇 Additional comments (2)
gp-inventory/gpi-populate-days.php (2)
50-55: One-time guard looks good.Prevents double-population across multiple hooks in a single request.
21-23: Hook setup is appropriate.ID-specific pre-render and pre-validation filters are correctly targeted.
Context
⛑️ Ticket(s): https://secure.helpscout.net/conversation/3049406579/88333?viewId=7627047
Summary
Added new snippet that will populate a Radio field with the next 10 Thursdays, and assign each choice an inventory of 25. It's customizable to use for other days, and includes the ability to set a cutoff day and time for populating the current week's day.