Add in-code notes about the workflow_name

diff --git a/CRM/Core/BAO/MessageTemplate.php b/CRM/Core/BAO/MessageTemplate.php
index 72395333019b900bd14a5a3977974a1049b7925a..1904d750cafa2474e7a48ccfe3284e7bb409371c 100644 (file)
--- a/CRM/Core/BAO/MessageTemplate.php
+++ b/CRM/Core/BAO/MessageTemplate.php
@@ -635,6 +635,11 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate {
       'text' => $messageTemplate['msg_text'],
       'html' => $messageTemplate['msg_html'],
       'format' => $messageTemplate['pdf_format_id'],
+      // Workflow name is the field in the message templates table that denotes the
+      // workflow the template is used for. This is intended to eventually
+      // replace the non-standard option value/group implementation - see
+      // https://github.com/civicrm/civicrm-core/pull/17227 and the longer
+      // discussion on https://github.com/civicrm/civicrm-core/pull/17180
       'workflow_name' => $workflowName,
       // Note messageTemplateID is the id but when present we also know it was specifically requested.
       'messageTemplateID' => $messageTemplateID,