Fix emails with special characters being displayed incorrectly in the subject line

changelog/fix-encoded-email-subject

@@ -0,0 +1,4 @@
+Significance: patch
+Type: fixed
+
+Email subject with special characters not being displayed correctly

includes/internal/emails/generators/class-course-completed.php

@@ -71,7 +71,7 @@ public function completed_course_mail_to_student( $status = 'in-progress', $stud
 					'student:id'          => $student_id,
 					'student:displayname' => $student->display_name,
 					'course:id'           => $course_id,
-					'course:name'         => get_the_title( $course_id ),
+					'course:name'         => html_entity_decode( get_the_title( $course_id ) ),
 					'completed:url'       => esc_url(
 						\Sensei_Course::get_course_completed_page_url( $course_id ) ?? get_permalink( $course_id )
 					),

includes/internal/emails/generators/class-new-course-assigned.php

@@ -82,7 +82,7 @@ public function course_new_teacher_assigned_email( $teacher_id, $course_id ) {
 			[
 				$recipient => [
 					'teacher:displayname' => $teacher->display_name,
-					'course:name'         => get_the_title( $course_id ),
+					'course:name'         => html_entity_decode( get_the_title( $course_id ) ),
 					'editcourse:url'      => esc_url( $edit_link ),
 				],
 			]

includes/internal/emails/generators/class-quiz-graded.php

@@ -94,7 +94,7 @@ public function quiz_graded_mail_to_student( $user_id, $quiz_id, $grade, $passma
 				$recipient => [
 					'grade:validation' => $pass_or_fail,
 					'course:name'      => get_the_title( $course->ID ),
-					'lesson:name'      => get_the_title( $lesson->ID ),
+					'lesson:name'      => html_entity_decode( get_the_title( $lesson->ID ) ),
 					'grade:percentage' => $grade . '%',
 					'quiz:url'         => $quiz_url,
 				],

includes/internal/emails/generators/class-student-completes-course.php

@@ -85,7 +85,7 @@ public function student_completed_course_mail_to_teacher( $status = 'in-progress
 			'student:id'          => $student_id,
 			'student:displayname' => $student->display_name,
 			'course:id'           => $course_id,
-			'course:name'         => get_the_title( $course_id ),
+			'course:name'         => html_entity_decode( get_the_title( $course_id ) ),
 			'grade:percentage'    => $grade,
 			'manage:students'     => $manage_url,
 		];

includes/internal/emails/generators/class-student-completes-lesson.php

@@ -110,7 +110,7 @@ public function student_completed_lesson_mail_to_teacher( $student_id, $lesson_i
 			'course:id'           => (int) $course_id,
 			'course:name'         => get_the_title( $course_id ),
 			'lesson:id'           => (int) $lesson_id,
-			'lesson:name'         => get_the_title( $lesson_id ),
+			'lesson:name'         => html_entity_decode( get_the_title( $lesson_id ) ),
 			'manage:students'     => $manage_url,
 		];
 

includes/internal/emails/generators/class-student-message-reply.php

@@ -102,7 +102,7 @@ public function message_reply_mail_to_student( $comment, $message ) {
 					'teacher:displayname'    => esc_html( $teacher->display_name ),
 					'course:name'            => esc_html( get_the_title( $course_id ) ),
 					'message:displaymessage' => esc_html( $comment->comment_content ),
-					'subject:displaysubject' => esc_html( $message->post_title ),
+					'subject:displaysubject' => html_entity_decode( esc_html( $message->post_title ) ),
 					'reply:url'              => esc_url( get_comment_link( $comment ) ),
 				],
 			]

includes/internal/emails/generators/class-student-sends-message.php

@@ -79,7 +79,7 @@
 					'student:displayname'    => esc_html( $student->display_name ),
 					'course:name'            => esc_html( get_the_title( $course->ID ) ),
 					'message:displaymessage' => esc_html( $message->post_content ),
-					'subject:displaysubject' => esc_html( $message->post_title ),
+					'subject:displaysubject' => html_entity_decode( esc_html( $message->post_title ) ),
 					'reply:url'              => esc_url( get_permalink( absint( $message_id ) ) ),
 				],
 			]

includes/internal/emails/generators/class-teacher-message-reply.php

@@ -79,7 +79,7 @@ public function message_reply_mail_to_teacher( $comment, $message ) {
 					'student:displayname'    => esc_html( $commenter->display_name ),
 					'course:name'            => esc_html( get_the_title( $course->ID ) ),
 					'message:displaymessage' => esc_html( $comment->comment_content ),
-					'subject:displaysubject' => esc_html( $message->post_title ),
+					'subject:displaysubject' => html_entity_decode( esc_html( $message->post_title ) ),
 					'reply:url'              => esc_url( get_comment_link( $comment ) ),
 				],
 			]

tests/unit-tests/internal/emails/generators/test-class-course-completed.php

@@ -57,7 +57,7 @@ public function testGenerateEmail_WhenStudentEnrolledAndCompletedTheCourse_Calls
 		);
 		$course        = $this->factory->course->create_and_get(
 			[
-				'post_title' => 'Test Course',
+				'post_title' => '“Course with Special Characters…?”',
 			]
 		);
 		$completed_url = \Sensei_Course::get_course_completed_page_url( $course->ID );
@@ -91,7 +91,7 @@ function ( $email_name, $replacements ) use ( &$email_data ) {
 		self::assertEquals( 'course_completed', $email_data['name'] );
 		self::assertArrayHasKey( '[email protected]', $email_data['data'] );
 		self::assertEquals( 'Test Student', $email_data['data']['[email protected]']['student:displayname'] );
-		self::assertEquals( 'Test Course', $email_data['data']['[email protected]']['course:name'] );
+		self::assertEquals( '“Course with Special Characters…?”', $email_data['data']['[email protected]']['course:name'] );
 		self::assertArrayHasKey( 'completed:url', $email_data['data']['[email protected]'] );
 		self::assertNotEmpty( $email_data['data']['[email protected]']['completed:url'] );
 	}
@@ -195,5 +195,4 @@ function ( $email_name, $replacements ) use ( &$email_data ) {
 		/* Assert. */
 		self::assertEmpty( $email_data['name'] );
 	}
-
 }

tests/unit-tests/internal/emails/generators/test-class-course-welcome.php

@@ -91,7 +91,7 @@ public function testWelcomeToCourseForStudent_WhenCalled_CallsSenseiEmailSendFil
 		);
 		$course_id  = $factory->course->create(
 			[
-				'post_title'  => 'Test Course',
+				'post_title'  => '“Course with Special Characters…?”',
 				'post_author' => $teacher_id,
 			]
 		);
@@ -123,7 +123,7 @@ public function testWelcomeToCourseForStudent_WhenCalled_CallsSenseiEmailSendFil
 					'student:id'          => $student_id,
 					'student:displayname' => 'Test Student',
 					'course:id'           => $course_id,
-					'course:name'         => 'Test Course',
+					'course:name'         => '“Course with Special Characters…?”',
 					'course:url'          => esc_url(
 						get_permalink( $course_id )
 					),

tests/unit-tests/internal/emails/generators/test-class-new-course-assigned.php

@@ -47,7 +47,7 @@ public function testSendNewCourseEmail_WhenTeacherAssignedToNewCourseEventFires_
 		);
 		$course     = $this->factory->course->create_and_get(
 			[
-				'post_title'  => 'Test Course',
+				'post_title'  => '“Course with Special Characters…?”',
 				'post_author' => $teacher_id,
 			]
 		);
@@ -85,7 +85,7 @@ function ( $email_name, $replacements ) use ( &$email_data ) {
 		self::assertEquals( 'new_course_assigned', $email_data['name'] );
 		self::assertArrayHasKey( '[email protected]', $email_data['data'] );
 		self::assertEquals( $user_name, $email_data['data']['[email protected]']['teacher:displayname'] );
-		self::assertEquals( 'Test Course', $email_data['data']['[email protected]']['course:name'] );
+		self::assertEquals( '“Course with Special Characters…?”', $email_data['data']['[email protected]']['course:name'] );
 		self::assertArrayHasKey( 'editcourse:url', $email_data['data']['[email protected]'] );
 		self::assertEquals( $edit_link, $email_data['data']['[email protected]']['editcourse:url'] );
 	}
@@ -101,7 +101,7 @@ public function testSendNewCourseEmail_WhenTeacherAssignedToNewCourseEventFires_
 		);
 		$course     = $this->factory->course->create_and_get(
 			[
-				'post_title'  => 'Test Course',
+				'post_title'  => '“Course with Special Characters…?”',
 				'post_author' => $teacher_id,
 			]
 		);

tests/unit-tests/internal/emails/generators/test-class-student-completes-course.php

@@ -61,7 +61,7 @@ public function testGenerateEmail_WhenCalledByStudentCompletedCourseEvent_CallsE
 		);
 		$course     = $this->factory->course->create_and_get(
 			[
-				'post_title'  => 'Test Course',
+				'post_title'  => '“Course with Special Characters…?”',
 				'post_author' => $teacher_id,
 			]
 		);
@@ -92,7 +92,7 @@ function ( $email_name, $replacements ) use ( &$email_data ) {
 		self::assertEquals( 'student_completes_course', $email_data['name'] );
 		self::assertArrayHasKey( '[email protected]', $email_data['data'] );
 		self::assertEquals( 'Test Student', $email_data['data']['[email protected]']['student:displayname'] );
-		self::assertEquals( 'Test Course', $email_data['data']['[email protected]']['course:name'] );
+		self::assertEquals( '“Course with Special Characters…?”', $email_data['data']['[email protected]']['course:name'] );
 		self::assertArrayHasKey( 'manage:students', $email_data['data']['[email protected]'] );
 		self::assertNotEmpty( $email_data['data']['[email protected]']['manage:students'] );
 	}
@@ -116,7 +116,7 @@ public function testGenerateEmail_WhenCalledByStudentCompletedCourseEventAndTeac
 		);
 		$course      = $this->factory->course->create_and_get(
 			[
-				'post_title'  => 'Test Course',
+				'post_title'  => '“Course with Special Characters…?”',
 				'post_author' => $teacher1_id,
 			]
 		);

tests/unit-tests/internal/emails/generators/test-class-student-completes-lesson.php

@@ -155,7 +155,7 @@ public function testStudentCompletedLessonMailToTeacher_LessonCompleted_CallsSen
 		);
 		$lesson_id        = $factory->lesson->create(
 			[
-				'post_title' => 'Test Lesson',
+				'post_title' => '“Lesson with Special Characters…?”',
 				'meta_input' => [
 					'_lesson_course' => $course_id,
 				],
@@ -193,7 +193,7 @@ public function testStudentCompletedLessonMailToTeacher_LessonCompleted_CallsSen
 					'course:id'           => $course_id,
 					'course:name'         => 'Test Course',
 					'lesson:id'           => $lesson_id,
-					'lesson:name'         => 'Test Lesson',
+					'lesson:name'         => '“Lesson with Special Characters…?”',
 					'manage:students'     => esc_url(
 						admin_url( "admin.php?page=sensei_learners&course_id={$course_id}&lesson_id={$lesson_id}&view=learners" )
 					),
@@ -233,7 +233,7 @@ public function testStudentCompletedLessonMailToTeacher_LessonCompletedAndTeache
 		);
 		$lesson_id        = $factory->lesson->create(
 			[
-				'post_title' => 'Test Lesson',
+				'post_title' => '“Lesson with Special Characters…?”',
 				'meta_input' => [
 					'_lesson_course' => $course_id,
 				],
@@ -277,7 +277,7 @@ public function testStudentCompletedLessonMailToTeacher_LessonCompletedAndTeache
 					'course:id'           => $course_id,
 					'course:name'         => 'Test Course',
 					'lesson:id'           => $lesson_id,
-					'lesson:name'         => 'Test Lesson',
+					'lesson:name'         => '“Lesson with Special Characters…?”',
 					'manage:students'     => esc_url(
 						admin_url( "admin.php?page=sensei_learners&course_id={$course_id}&lesson_id={$lesson_id}&view=learners" )
 					),
@@ -288,7 +288,7 @@ public function testStudentCompletedLessonMailToTeacher_LessonCompletedAndTeache
 					'course:id'           => $course_id,
 					'course:name'         => 'Test Course',
 					'lesson:id'           => $lesson_id,
-					'lesson:name'         => 'Test Lesson',
+					'lesson:name'         => '“Lesson with Special Characters…?”',
 					'manage:students'     => esc_url(
 						admin_url( "admin.php?page=sensei_learners&course_id={$course_id}&lesson_id={$lesson_id}&view=learners" )
 					),

tests/unit-tests/internal/emails/generators/test-class-student-message-reply.php

@@ -107,7 +107,7 @@ public function testTeacherRepliesMail_WhenCalled_CallsEmailSendingActionWithRig
 				'comment_post_ID'  => $course_id,
 				'user_id'          => $this->teacher_id,
 				'comment_type'     => 'comment',
-				'comment_content'  => 'Test reply',
+				'comment_content'  => '“Message Reply with Special Characters…?”',
 				'comment_approved' => 1,
 			]
 		);
@@ -171,7 +171,7 @@ public function testTeacherRepliesMail_WhenMessageSentFromLesson_CallsEmailSendi
 				'comment_post_ID'  => $lesson_id,
 				'user_id'          => $this->teacher_id,
 				'comment_type'     => 'comment',
-				'comment_content'  => 'Test reply',
+				'comment_content'  => '“Message Reply with Special Characters…?”',
 				'comment_approved' => 1,
 			]
 		);
@@ -235,7 +235,7 @@ public function testTeacherRepliesMail_WhenMessageSentFromQuiz_CallsEmailSending
 				'comment_post_ID'  => $quiz_id,
 				'user_id'          => $this->teacher_id,
 				'comment_type'     => 'comment',
-				'comment_content'  => 'Test reply',
+				'comment_content'  => '“Message Reply with Special Characters…?”',
 				'comment_approved' => 1,
 			]
 		);
@@ -297,7 +297,7 @@ public function testReplyMail_WhenCalled_DoesNotSendMailToStudentWhenStudentRepl
 				'comment_post_ID'  => $course_id,
 				'user_id'          => $this->student_id,
 				'comment_type'     => 'comment',
-				'comment_content'  => 'Test reply',
+				'comment_content'  => '“Message Reply with Special Characters…?”',
 				'comment_approved' => 1,
 			]
 		);

tests/unit-tests/internal/emails/generators/test-class-student-sends-message.php

@@ -66,7 +66,7 @@ public function testStudentSendsNewMessage_WhenEventFires_CallsEmailSendingActio
 		$message     = $this->factory->post->create_and_get(
 			[
 				'post_type'   => 'sensei_message',
-				'post_title'  => 'Test message',
+				'post_title'  => '“Message with Special Characters…?”',
 				'post_status' => 'publish',
 				'post_author' => $student_id,
 				'meta_input'  => [
@@ -131,7 +131,7 @@ public function testStudentSendsNewMessage_WhenCalled_DoesNotSendMailIfAnyOfTheU
 		$message = $this->factory->post->create_and_get(
 			[
 				'post_type'   => 'sensei_message',
-				'post_title'  => 'Test message',
+				'post_title'  => '“Message with Special Characters…?”',
 				'post_status' => 'publish',
 				'post_author' => $student_id,
 				'meta_input'  => [

tests/unit-tests/internal/emails/generators/test-class-student-starts-course.php

@@ -50,7 +50,7 @@ public function testGenerateEmail_WhenCalledByStudentStartCourseEvent_CallsEmail
 		);
 		$course     = $this->factory->course->create_and_get(
 			[
-				'post_title'  => 'Test Course',
+				'post_title'  => '“Course with Special Characters…?”',
 				'post_author' => $teacher_id,
 			]
 		);
@@ -89,7 +89,7 @@ function ( $email_name, $replacements ) use ( &$email_data ) {
 		self::assertEquals( 'student_starts_course', $email_data['name'] );
 		self::assertArrayHasKey( '[email protected]', $email_data['data'] );
 		self::assertEquals( 'Test Student', $email_data['data']['[email protected]']['student:displayname'] );
-		self::assertEquals( 'Test Course', $email_data['data']['[email protected]']['course:name'] );
+		self::assertEquals( '“Course with Special Characters…?”', $email_data['data']['[email protected]']['course:name'] );
 		self::assertEquals( $manage_url, $email_data['data']['[email protected]']['manage:students'] );
 	}
 }

tests/unit-tests/internal/emails/generators/test-class-teacher-message-reply.php

@@ -84,7 +84,7 @@ public function testStudentRepliesMail_WhenCalled_CallsEmailSendingActionWithRig
 				'comment_post_ID'  => $course_id,
 				'user_id'          => $student_id,
 				'comment_type'     => 'comment',
-				'comment_content'  => 'Test reply',
+				'comment_content'  => '“Message Reply with Special Characters…?”',
 				'comment_approved' => 1,
 			]
 		);
@@ -170,7 +170,7 @@ public function testReplyMail_WhenCalled_DoesNotSendMailToTeacherWhenTeacherRepl
 				'comment_post_ID'  => $course_id,
 				'user_id'          => $teacher_id,
 				'comment_type'     => 'comment',
-				'comment_content'  => 'Test reply',
+				'comment_content'  => '“Message Reply with Special Characters…?”',
 				'comment_approved' => 1,
 			]
 		);