Before and after form hooks order

rubengc · rubengc · commit bcb882ced4b6 · 2017-04-04T18:58:12.000+02:00
This is a backwards-compatibility break. If your theme or plugin is
using some of next action hooks and your are connecting the output
between them then take a look a this explanation

Hooks have been called in this order (until this PR):
`cmb2_before_form`
`cmb2_before_{$object_type}_form_{$cmb_id}`
`cmb2_after_form`
`cmb2_after_{$object_type}_form_{$cmb_id}`

And now they are called at this order:
`cmb2_before_form`
`cmb2_before_{$object_type}_form_{$cmb_id}`
`cmb2_after_{$object_type}_form_{$cmb_id}`
`cmb2_after_form`

Why? Because this means call this hooks is really dangerous because you
could break your html if you expect a relative order, for example, if
two plugins using this hooks to print something, the most common
workflow is use same relative callbacks (`cmb2_before_form` and
`cmb2_after_form`) or (`cmb2_before_{$object_type}_form_{$cmb_id}` and
`cmb2_after_{$object_type}_form_{$cmb_id}`)

A visual example with two plugins (Plugin 1 and Plugin 2):
Current order:
`cmb2_before_form` Plugin 1 opens a div
`cmb2_before_{$object_type}_form_{$cmb_id}` Plugin 2 prints a p
`cmb2_after_form`  Plugin 1 closes the div
`cmb2_after_{$object_type}_form_{$cmb_id}` Plugin 2 closes the p

Result:
``` html
&lt;div&gt;
&lt;p&gt;
&lt;/div&gt;
&lt;/p&gt;
```

New order:
`cmb2_before_form` Plugin 1 opens a div
`cmb2_before_{$object_type}_form_{$cmb_id}` Plugin 2 prints a p
`cmb2_after_{$object_type}_form_{$cmb_id}` Plugin 2 closes the p
`cmb2_after_form`  Plugin 1 closes the div

Result:
``` html
&lt;div&gt;
&lt;p&gt;
&lt;/p&gt;
&lt;/div&gt;
```
diff --git a/includes/CMB2.php b/includes/CMB2.php
@@ -321,18 +321,6 @@ public function render_form_close( $object_id = 0, $object_type = '' ) {
 
 		$this->render_hidden_fields();
 
-		/**
-		 * Hook after form form has been rendered
-		 *
-		 * @param array  $cmb_id      The current box ID.
-		 * @param int    $object_id   The ID of the current object.
-		 * @param string $object_type The type of object you are working with.
-		 *	                           Usually `post` (this applies to all post-types).
-		 *	                           Could also be `comment`, `user` or `options-page`.
-		 * @param array  $cmb         This CMB2 object.
-		 */
-		do_action( 'cmb2_after_form', $this->cmb_id, $object_id, $object_type, $this );
-
 		/**
 		 * Hook after form form has been rendered
 		 *
@@ -347,6 +335,18 @@ public function render_form_close( $object_id = 0, $object_type = '' ) {
 		 */
 		do_action( "cmb2_after_{$object_type}_form_{$this->cmb_id}", $object_id, $this );
 
+		/**
+		 * Hook after form form has been rendered
+		 *
+		 * @param array  $cmb_id      The current box ID.
+		 * @param int    $object_id   The ID of the current object.
+		 * @param string $object_type The type of object you are working with.
+		 *	                           Usually `post` (this applies to all post-types).
+		 *	                           Could also be `comment`, `user` or `options-page`.
+		 * @param array  $cmb         This CMB2 object.
+		 */
+		do_action( 'cmb2_after_form', $this->cmb_id, $object_id, $object_type, $this );
+
 		echo "\n<!-- End CMB2 Fields -->\n";
 
 	}
