Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Prevent sending welcome email immediately on enrole in case their access starts in the future #7615

Open
wants to merge 11 commits into
base: trunk
Choose a base branch
from
Open

Prevent sending welcome email immediately on enrole in case their access starts in the future #7615

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
5cb38d7
Add extra replacements param in email hook
Imran92 Jun 2, 2024
3f27646
Send replacement param in email hook
Imran92 Jun 2, 2024
c3a0fcf
Allow email to be called on multiple action
Imran92 Jun 2, 2024
27fc934
Add action to send email on course access start
Imran92 Jun 3, 2024
847baa4
Add test to make sure both event gets registered
Imran92 Jun 3, 2024
5906d7e
Update hook name
Imran92 Jun 3, 2024
68e34e4
Use different hook to access the start date
Imran92 Jun 3, 2024
35e594f
Update test to use new hook
Imran92 Jun 3, 2024
599c4b8
Make is_enrolled optiona
Imran92 Jun 10, 2024
7a8ea95
Change the hook
Imran92 Jun 10, 2024
818e048
Merge branch 'trunk' into fix/prevent-welcome-email-for-future-access
Imran92 Jun 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions includes/class-sensei-emails.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ function send( $to, $subject, $message, $headers = "Content-Type: text/html\r\n"
// Set content type
$this->_content_type = $content_type;

// Filters for the email
// Filters for the email.
add_filter( 'wp_mail_from', array( $this, 'get_from_address' ) );
add_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ) );
add_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ) );
Expand All @@ -183,20 +183,22 @@ function send( $to, $subject, $message, $headers = "Content-Type: text/html\r\n"
*
* @hook sensei_send_emails
*
* @param {bool} $send_email Whether to send the email or not.
* @param {mixed} $to The email address(es) to send the email to.
* @param {mixed} $subject The subject of the email.
* @param {mixed} $message The message of the email.
* @param {string} $identifier Unique identifier of the email, not for legacy emails.
* @param {bool} $send_email Whether to send the email or not.
* @param {mixed} $to The email address(es) to send the email to.
* @param {mixed} $subject The subject of the email.
* @param {mixed} $message The message of the email.
* @param {string} $identifier Unique identifier of the email, not for legacy emails.
* @param {array} $replacements The replacements values for the email, not for legacy emails.
*
* @return {bool} Whether to send the email or not.
*/
if ( apply_filters( 'sensei_send_emails', true, $to, $subject, $message, 'legacy-email' ) ) {
if ( apply_filters( 'sensei_send_emails', true, $to, $subject, $message, 'legacy-email', [] ) ) {

wp_mail( $to, $subject, $message, $headers, $attachments );

}

// Unhook filters
// Unhook filters.
remove_filter( 'wp_mail_from', array( $this, 'get_from_address' ) );
remove_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ) );
remove_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ) );
Expand Down
14 changes: 7 additions & 7 deletions includes/internal/emails/class-email-sender.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ public function send_email( $email_name, $replacements, $usage_tracking_type ) {
/*
* For documentation of the filter check class-sensei-emails.php file.
*/
if ( apply_filters( 'sensei_send_emails', true, $recipient, $subject, $message, $email_name ) ) {
if ( apply_filters( 'sensei_send_emails', true, $recipient, $subject, $message, $email_name, $replacement ) ) {
wp_mail(
$recipient,
$subject,
Expand Down Expand Up @@ -229,17 +229,17 @@ public function get_email_body( WP_Post $email_post, array $placeholders = [] ):
*
* @internal
*
* @param string $string The string.
* @param array $placeholders The placeholders.
* @param string $template_body The string.
* @param array $placeholders The placeholders.
*
* @return string
*/
private function replace_placeholders( string $string, array $placeholders ): string {
private function replace_placeholders( string $template_body, array $placeholders ): string {
foreach ( $placeholders as $placeholder => $value ) {
$string = str_replace( '[' . $placeholder . ']', $value, $string );
$template_body = str_replace( '[' . $placeholder . ']', $value, $template_body );
}

return $string;
return $template_body;
}

/**
Expand Down Expand Up @@ -322,7 +322,7 @@ private function add_base_url_for_images( $content ) {
*
* @return array Headers.
*/
private function get_email_headers():array {
private function get_email_headers(): array {
$settings = $this->settings->get_settings();
$headers = [
'Content-Type: text/html; charset=UTF-8',
Expand Down
16 changes: 12 additions & 4 deletions includes/internal/emails/generators/class-course-welcome.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,18 +41,26 @@ class Course_Welcome extends Email_Generators_Abstract {
* @return void
*/
public function init() {
$this->maybe_add_action( 'sensei_user_course_start', [ $this, 'welcome_to_course_for_student' ], 10, 2 );
$this->maybe_add_action( 'sensei_course_enrolment_status_changed', [ $this, 'welcome_to_course_for_student' ], 10, 3 );

// Send welcome email on the day the student gets access to the course.
$this->maybe_add_action( 'sensei_pro_course_access_start_student_email_send', [ $this, 'welcome_to_course_for_student' ], 10, 2 );
}

/**
* Send email to student when they are enrolled in a course.
*
* @access private
*
* @param int $student_id The student ID.
* @param int $course_id The course ID.
* @param int $student_id The student ID.
* @param int $course_id The course ID.
* @param bool $is_enrolled Whether the student is enrolled in the course.
*/
public function welcome_to_course_for_student( $student_id, $course_id ) {
public function welcome_to_course_for_student( $student_id, $course_id, $is_enrolled = true ) {
if ( ! $is_enrolled ) {
return;
}

$course = get_post( $course_id );
if ( ! $course || 'publish' !== $course->post_status ) {
return;
Expand Down
43 changes: 13 additions & 30 deletions includes/internal/emails/generators/class-email-generators-abstract.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,32 +44,11 @@ abstract class Email_Generators_Abstract {
protected $repository;

/**
* Action name.
* All registered actions.
*
* @var string
*/
private $action = '';

/**
* Callback name.
*
* @var callable
*/
private $callback = '';

/**
* Priority.
*
* @var int
* @var array
*/
private $priority = 10;

/**
* Accepted arguments.
*
* @var int
*/
private $accepted_args = 1;
private $actions = [];

/**
* Email_Generators_Abstract constructor.
Expand Down Expand Up @@ -121,10 +100,11 @@ public function is_email_active() {
* @param int $accepted_args Accepted arguments.
*/
protected function maybe_add_action( $action, $callback, $priority = 10, $accepted_args = 1 ) {
$this->action = $action;
$this->callback = $callback;
$this->priority = $priority;
$this->accepted_args = $accepted_args;
$this->actions[ $action ] = [
'callback' => $callback,
'priority' => $priority,
'accepted_args' => $accepted_args,
];

add_action( $action, [ $this, 'add_action_if_email_active' ], 1 );
}
Expand All @@ -137,8 +117,11 @@ protected function maybe_add_action( $action, $callback, $priority = 10, $accept
* @internal
*/
public function add_action_if_email_active() {
if ( $this->is_email_active() ) {
add_action( $this->action, $this->callback, $this->priority, $this->accepted_args );
$current_action_name = current_filter();

if ( $this->is_email_active() && array_key_exists( $current_action_name, $this->actions ) ) {
$action = $this->actions[ $current_action_name ];
add_action( $current_action_name, $action['callback'], $action['priority'], $action['accepted_args'] );
}
}

Expand Down
12 changes: 8 additions & 4 deletions tests/unit-tests/internal/emails/generators/test-class-course-welcome.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,13 @@ public function testInit_WhenCalled_AddsHooksForInitializingIndividualEmails() {
$generator->init();

/* Assert. */
do_action( 'sensei_user_course_start', 1, 1 );
$priority = has_action( 'sensei_user_course_start', [ $generator, 'welcome_to_course_for_student' ] );
self::assertSame( 10, $priority );
do_action( 'sensei_course_enrolment_status_changed', 1, 1 );
do_action( 'sensei_pro_course_access_start_student_email_send', 1, 1 );

$priority_for_immediate_start = has_action( 'sensei_course_enrolment_status_changed', [ $generator, 'welcome_to_course_for_student' ] );
$priority_for_access_start = has_action( 'sensei_pro_course_access_start_student_email_send', [ $generator, 'welcome_to_course_for_student' ] );
self::assertSame( 10, $priority_for_immediate_start );
self::assertSame( 10, $priority_for_access_start );
}

public function testWelcomeToCourseForStudent_WhenCalled_CallsSenseiEmailSendFilterWithMatchingArguments() {
Expand Down Expand Up @@ -102,7 +106,7 @@ public function testWelcomeToCourseForStudent_WhenCalled_CallsSenseiEmailSendFil
$generator = new Course_Welcome( $email_repository );

$actual_data = [];
$filter = function( $email, $options ) use ( &$actual_data ) {
$filter = function ( $email, $options ) use ( &$actual_data ) {
$actual_data = [
'email' => $email,
'options' => $options,
Expand Down
Loading