Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 73 additions & 0 deletions gp-unique-id/gpuid-generate-post-workflow.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
<?php
/**
* Gravity Perks // Unique ID // Conditional Unique ID for Gravity Flow
* https://gravitywiz.com/documentation/gravity-forms-unique-id/
*
* Instruction Video: https://www.loom.com/share/e799e8b4b0984d99a66da79faa34ffee
*
* Prevent a Unique ID field from generating its value until a specific Gravity Flow Workflow step is completed.
* Useful when you want to generate the Unique ID only after approval or other workflow steps.
*
* Plugin Name: Conditional Unique ID for Gravity Flow
* Plugin URI: https://gravitywiz.com/documentation/gravity-forms-unique-id/
* Description: Prevent a Unique ID field from generating its value until a specific Gravity Flow step is completed.
* Author: Gravity Wiz
* Version: 0.1
* Author URI: https://gravitywiz.com
*/
class GPUID_Generate_Post_Workflow {

private $_args = array();

public function __construct( $args = array() ) {

$this->_args = wp_parse_args( $args, array(
'form_id' => false,
'field_id' => false,
'step_id' => false,
) );

if ( ! $this->_args['form_id'] || ! $this->_args['field_id'] || ! $this->_args['step_id'] ) {
return;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thoughts on throwing individual exceptions here including a message with the exact missing args?

For example:

Suggested change
return;
if ( ! $this->_args['form_id'] ) throw new Exception( 'GPUID_Generate_Post_Workflow: Form ID is required.')

}

add_action( 'init', array( $this, 'init' ) );

}

public function init() {

add_filter( 'gpui_unique_id', array( $this, 'prevent_unique_id_generation' ), 10, 3 );
add_action( 'gravityflow_step_complete', array( $this, 'maybe_generate_unique_id' ), 10, 4 );

}

public function prevent_unique_id_generation( $unique, $form_id, $field_id ) {

if ( $form_id == $this->_args['form_id'] && $field_id == $this->_args['field_id'] && ! gravity_flow()->is_workflow_detail_page() ) {
return '';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be null? Or will null cause issues?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

empty character is how we do it on GPUID as well. null may cause issues.

}

return $unique;
}

public function maybe_generate_unique_id( $step_id, $entry_id, $form_id, $status ) {

if ( $step_id == $this->_args['step_id'] && $form_id == $this->_args['form_id'] ) {
$entry = GFAPI::get_entry( $entry_id );
if ( ! is_wp_error( $entry ) && empty( $entry[ $this->_args['field_id'] ] ) ) {
$uid_field = GFAPI::get_field( $form_id, $this->_args['field_id'] );
$uid_field->save_value( GFAPI::get_entry( $entry_id ), $uid_field, false );
}
}
}
Copy link

@coderabbitai coderabbitai bot May 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Redundant API call in the maybe_generate_unique_id method.

There's an unnecessary duplicate call to GFAPI::get_entry() at line 60 when you've already retrieved the entry at line 57.

 if ( $step_id == $this->_args['step_id'] && $form_id == $this->_args['form_id'] ) {
 	$entry = GFAPI::get_entry( $entry_id );
 	if ( ! is_wp_error( $entry ) && empty( $entry[ $this->_args['field_id'] ] ) ) {
 		$uid_field = GFAPI::get_field( $form_id, $this->_args['field_id'] );
-		$uid_field->save_value( GFAPI::get_entry( $entry_id ), $uid_field, false );
+		$uid_field->save_value( $entry, $uid_field, false );
 	}
 }

Also, consider using strict comparison operators here:

-if ( $step_id == $this->_args['step_id'] && $form_id == $this->_args['form_id'] ) {
+if ( (int) $step_id === $this->_args['step_id'] && (int) $form_id === $this->_args['form_id'] ) {
📝 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.

Suggested change
public function maybe_generate_unique_id( $step_id, $entry_id, $form_id, $status ) {
if ( $step_id == $this->_args['step_id'] && $form_id == $this->_args['form_id'] ) {
$entry = GFAPI::get_entry( $entry_id );
if ( ! is_wp_error( $entry ) && empty( $entry[ $this->_args['field_id'] ] ) ) {
$uid_field = GFAPI::get_field( $form_id, $this->_args['field_id'] );
$uid_field->save_value( GFAPI::get_entry( $entry_id ), $uid_field, false );
}
}
}
public function maybe_generate_unique_id( $step_id, $entry_id, $form_id, $status ) {
if ( (int) $step_id === $this->_args['step_id'] && (int) $form_id === $this->_args['form_id'] ) {
$entry = GFAPI::get_entry( $entry_id );
if ( ! is_wp_error( $entry ) && empty( $entry[ $this->_args['field_id'] ] ) ) {
$uid_field = GFAPI::get_field( $form_id, $this->_args['field_id'] );
$uid_field->save_value( $entry, $uid_field, false );
}
}
}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a good suggestion 🧐

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@veryspry Thanks for confirming! The changes will make the code more efficient by eliminating the redundant API call and more robust with strict type comparisons. Would you like me to help with anything else on this snippet?


If you found this review helpful, would you consider giving us a shout-out on X?

Thank you for using CodeRabbit!


}

# Configuration

new GPUID_Generate_Post_Workflow( array(
'form_id' => 5, // Replace with your form ID.
'field_id' => 3, // Replace with your Unique ID field ID.
'step_id' => 3 // Replace with your Gravity Flow step ID.
) );
Loading