Add ProgramFunctions/Template.fnc.php|before_get & `ProgramFunction…

…s/Template.fnc.php|before_save` action hooks

CHANGES.md

@@ -9,6 +9,7 @@ Changes in 11.4.1
 - Fix PHP warning use reset() instead of guessing if $errors[1] is set in ErrorMessage.fnc.php & diagnostic.php
 - Add arguments to Action tags PHPDoc in Actions.php
 - Add `Students/Letters.php|header` action hook in Actions.php & Letters.php
+- Add `ProgramFunctions/Template.fnc.php|before_get` & `ProgramFunctions/Template.fnc.php|before_save` action hooks in Actions.php & Template.fnc.php
 
 Changes in 11.4
 ---------------

ProgramFunctions/Template.fnc.php

@@ -15,6 +15,7 @@
  *
  * @since 3.6
  * @since 10.2.3 Get template from last school year (rollover ID)
+ * @since 11.4.1 Add `ProgramFunctions/Template.fnc.php|before_get` action hook
  *
  * @example GetTemplate( $_REQUEST['modname'], User( 'STAFF_ID' ) )
  *
@@ -59,6 +60,19 @@ function GetTemplate( $modname = '', $staff_id = 0 ) {
 		$staff_id_sql .= ",'" . $staff_id . "'";
 	}
 
+	/**
+	 * Template before get
+	 * Filter &$modname var
+	 *
+	 * @since 11.4.1
+	 */
+	do_action( 'ProgramFunctions/Template.fnc.php|before_get', [ &$modname ] );
+
+	if ( ! $modname )
+	{
+		return '';
+	}
+
 	$template = DBGetOne( "SELECT TEMPLATE
 		FROM templates
 		WHERE MODNAME='" . $modname . "'
@@ -75,14 +89,15 @@ function GetTemplate( $modname = '', $staff_id = 0 ) {
  *
  * @since 3.6
  * @since 5.0 Save Template even if no default template found.
+ * @since 11.4.1 Add `ProgramFunctions/Template.fnc.php|before_save` action hook
  *
  * @example SaveTemplate( DBEscapeString( SanitizeHTML( $_POST['inputfreetext'] ) ) );
  *
  * @param string  $template Template text or HTML (use DBEscapeString() & SanitizeHTML() first!).
  * @param string  $modname  Specify program name (optional) defaults to current program.
  * @param integer $staff_id User ID (optional), defaults to logged in User, use 0 for default template.
  *
- * @return boolean False if no template found, else true if saved.
+ * @return boolean False if no modname, else true if saved.
  */
 function SaveTemplate( $template, $modname = '', $staff_id = -1 )
 {
@@ -96,17 +111,24 @@ function SaveTemplate( $template, $modname = '', $staff_id = -1 )
 		$staff_id = User( 'STAFF_ID' );
 	}
 
+	/**
+	 * Template before save
+	 * Filter &$modname, &$staff_id var
+	 *
+	 * @since 11.4.1
+	 */
+	do_action( 'ProgramFunctions/Template.fnc.php|before_save', [ &$modname, &$staff_id ] );
+
+	if ( ! $modname )
+	{
+		return false;
+	}
+
 	$is_template_update = DBGet( "SELECT STAFF_ID
 		FROM templates
 		WHERE MODNAME='" . $modname . "'
 		AND STAFF_ID IN(0,'" . $staff_id . "')", [], [ 'STAFF_ID' ] );
 
-	/*if ( ! $is_template_update )
-	{
-		// Default template not found for modname.
-		return false;
-	}*/
-
 	DBUpsert(
 		'templates',
 		[ 'TEMPLATE' => $template ],

functions/Actions.php

@@ -498,6 +498,22 @@
 	 * @since 11.4.1
 	 */
 	/*'Students/Letters.php|header' => [],
+
+	/**
+	 * Template before get
+	 * Filter &$modname var
+	 *
+	 * @since 11.4.1
+	 */
+	/*'ProgramFunctions/Template.fnc.php|before_get' => [ &$modname ],
+
+	/**
+	 * Template before save
+	 * Filter &$modname, &$staff_id var
+	 *
+	 * @since 11.4.1
+	 */
+	/*'ProgramFunctions/Template.fnc.php|before_save' => [ &$modname, &$staff_id ],
 );*/
 
 /**