Add original form id and random form id to gform_multiple_instances_s…

…trings filter (#23)

* change: add parameters to gform_multiple_instances_strings filter, form_id and random_id, for convenience and less error prone code, avoiding string replacement to determine form ids

* fix: missing line breaks

* fix: change testGformMultipleInstancesStringsFilter test case to reflect new gform_multiple_instances_strings filter arguments, now containing original form id and new random form id

* fix: fix Missing argument 2 for GFMFI_GformGetFormFilterTest::gform_multiple_instances_strings() by adding the correct number of parameters to add_filter function

README.md

@@ -38,6 +38,10 @@ Additionally, the plugin offers the following actions & filters:
 
 ##### gform\_multiple\_instances\_strings
 
-**$strings** *(array)*. An array of find => replace pairs. Occurences of "key" will be replaced with the corresponding "value".
+**$strings**   *(array)*. An array of find => replace pairs. Occurences of "key" will be replaced with the corresponding "value".
+
+**$form_id**   *(int)*.   The original form id.
+
+**$random_id** *(int)*.   The new, randomly generated form id.
 
 This filter allows you to modify the default strings that will be replaced. The keys are the original strings, and the corresponding values are the strings that keys will be replaced with.

gravityforms-multiple-form-instances.php

@@ -99,7 +99,7 @@ public function gform_get_form_filter( $form_string, $form ) {
 		);
 
 		// allow addons & plugins to add additional find & replace strings
-		$strings = apply_filters( 'gform_multiple_instances_strings', $strings );
+		$strings = apply_filters( 'gform_multiple_instances_strings', $strings, $form['id'], $random_id );
 
 		// replace all occurences with the new unique ID
 		foreach ( $strings as $find => $replace ) {

tests/unit-tests/GFMFI_GformGetFormFilterTest.php

@@ -2,8 +2,8 @@
 
 class GFMFI_GformGetFormFilterTest extends WP_UnitTestCase {
 
-	public function gform_multiple_instances_strings( $strings ) {
-		$strings['fooBar'] = 'barFoo';
+	public function gform_multiple_instances_strings( $strings, $form_id, $random_id ) {
+		$strings['foo_' . $form_id . '_'] = 'foo_' . $random_id . '_';
 		return $strings;
 	}
 
@@ -509,15 +509,15 @@ public function testHiddenFieldAddition() {
 	 * @covers Gravity_Forms_Multiple_Form_Instances::gform_get_form_filter
 	 */
 	public function testGformMultipleInstancesStringsFilter() {
-		add_filter( 'gform_multiple_instances_strings', array($this, 'gform_multiple_instances_strings') );
+		add_filter( 'gform_multiple_instances_strings', array($this, 'gform_multiple_instances_strings'), 10, 3 );
 
-		$input = "fooBar";
-		$expected = "barFoo";
+		$input = 'foo_' . $this->form['id'] . '_';
+		$expected = 'foo_' . $this->randomId . '_';
 		$actual = $this->gfmfi->gform_get_form_filter( $input, $this->form );
 
 		$this->assertSame( $expected, $actual );
 
-		remove_filter( 'gform_multiple_instances_strings', array($this, 'gform_multiple_instances_strings') );
+		remove_filter( 'gform_multiple_instances_strings', array($this, 'gform_multiple_instances_strings'), 10 );
 	}
 
 }