Add Email Testing documentation to handbook#118
Add Email Testing documentation to handbook#118ozgursar wants to merge 10 commits intoWordPress:trunkfrom
Conversation
|
|
||
| 2. Run the command `docker compose up -d mail` in your terminal | ||
| 3. Test access to Mailpit at `http://localhost:8025/` | ||
| 4. Add the following snippet to your `functions.php` or via [Code Snippets](https://wordpress.org/plugins/code-snippets/) plugin |
There was a problem hiding this comment.
Add the following snippet to your functions.php doesn't specify which functions.php file. Could you update this to mention the active theme's functions.php to avoid confusion?
Suggested wording:
Add the following snippet to your active theme's
functions.phpfile.
ozgursar
left a comment
ozgursar
left a comment
There was a problem hiding this comment.
I've completed the suggested wording changes.
nikunj8866
left a comment
nikunj8866
left a comment
There was a problem hiding this comment.
Thanks @ozgursar LGTM!
|
All comments have been addressed, this LGTM! |
nikunj8866
left a comment
nikunj8866
left a comment
There was a problem hiding this comment.
@ozgursar It needs to be added to the handbook-manifest.json. See: https://github.com/WordPress/test-handbook/pull/110/changes#diff-43b4dcabac07f1fdc2d3c98e5b9584ec7400522cb065eebef508235a8c8363c5 for the reference.
|
For testing emails with WP Studio, maybe is worth to also mention this tool by @jonathanbossenger |
@nikunj8866 I added email testing to the |
huzaifaalmesbah
left a comment
huzaifaalmesbah
left a comment
There was a problem hiding this comment.
Great documentation @ozgursar! This is really helpful for testers. I've suggested some minor changes.
@juanmaguitar This would be a good addition to the documentation. I don't have any experience with WP Studio and would like to get some help with adding information about this tool. |
Co-authored-by: Huzaifa Al Mesbah <[email protected]>
Co-authored-by: Huzaifa Al Mesbah <[email protected]>
Co-authored-by: Huzaifa Al Mesbah <[email protected]>
Co-authored-by: Huzaifa Al Mesbah <[email protected]>
Co-authored-by: Huzaifa Al Mesbah <[email protected]>
Co-authored-by: Huzaifa Al Mesbah <[email protected]>
Thank you for reviewing @huzaifaalmesbah. I committed your changes. |
@juanmaguitar I added WP Mail as the third tool for mail testing. But I'm not sure whether we should call it WP Mail or wp-mail. Can we get feedback from @jonathanbossenger? |
6 participants
Summary
This PR adds a new "Email Testing" page to the handbook that explains the importance of testing WordPress core transactional emails and provides two methods for capturing emails during testing.
What's included
Why this matters
Without proper email testing mechanisms, transactional emails triggered during testing either fail silently or get sent to real addresses, making it difficult to verify that core WordPress functionality works correctly. This documentation helps testers capture and inspect emails to ensure proper triggering, content, and formatting.