CRM-21020 add context details to alterMailContent hook #10815
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
monishdeb
reviewed
Dec 29, 2017
| @@ -406,6 +406,9 @@ public static function sendTemplate($params) { | |||
| 'text' => $dao->text, | |||
| 'html' => $dao->html, | |||
| 'format' => $dao->format, | |||
| 'groupName' => $params['groupName'], | |||
| 'valueName' => $params['valueName'], | |||
| 'messageTemplateID' => $params['messageTemplateID'], | |||
There was a problem hiding this comment.
At this point the $params will always have these 3 information as there is a check at L365 above.
|
@lcdservices Brian thanks for this are you able to make a PR against the developer Docs to update the documentation about the hook? |
|
I had a thought about this, which I found that there is already a doc on this hook but need to change the description under 'Details' to: Also if we can add an example? |
|
here's the doc PR: |
sluc23
pushed a commit
to ixiam/civicrm-core
that referenced
this pull request
Jan 10, 2018
CRM-21020 add context details to alterMailContent hook
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
The alterMailContent hook can be used to alter templates and email content before token processing occurs. Currently it only passes the subject, html, and text content to the hook, which means you have very little context to work with.
When this is triggered via msg template generation, include details about the template so the hook implementation can be conditioned meaningfully.
Technical Details
Includes template groupName, valueName, messageTemplateID when the hook is called from the message template context.