woothemes / sensei

includes/class-sensei-learner-profiles.php

Indentation +49 added lines, -49 removed lines

@@ -10,10 +10,10 @@ 
  * @since 1.4.0
  */
 class Sensei_Learner_Profiles {
-    /**
-     * @var string
-     */
-    private $profile_url_base;
+	/**
+	 * @var string
+	 */
+	private $profile_url_base;
 
 	/**
 	 * Constructor.
@@ -42,8 +42,8 @@ 
 	 */
 	public function setup_permastruct() {
 
-        if( isset( Sensei()->settings->settings[ 'learner_profile_enable' ] )
-            && Sensei()->settings->settings[ 'learner_profile_enable' ] ) {
+		if( isset( Sensei()->settings->settings[ 'learner_profile_enable' ] )
+			&& Sensei()->settings->settings[ 'learner_profile_enable' ] ) {
 
 			add_rewrite_rule( '^' . $this->profile_url_base . '/([^/]*)/?', 'index.php?learner_profile=$matches[1]', 'top' );
 			add_rewrite_tag( '%learner_profile%', '([^&]+)' );
@@ -62,7 +62,7 @@ 
 		if( isset( $wp_query->query_vars['learner_profile'] ) ) {
 			$learner_user = get_user_by( 'login', $wp_query->query_vars['learner_profile'] );
 
-            $name = Sensei_Learner::get_full_name( $learner_user->ID );
+			$name = Sensei_Learner::get_full_name( $learner_user->ID );
 
 			$title = apply_filters( 'sensei_learner_profile_courses_heading', sprintf( __( 'Courses %s is taking', 'woothemes-sensei' ), $name ) ) . ' ' . $sep . ' ';
 		}
@@ -110,7 +110,7 @@ 
 
 			if( isset( $wp_query->query_vars['learner_profile'] ) ) {
 
-                Sensei_Templates::get_template( 'learner-profile/learner-info.php' );
+				Sensei_Templates::get_template( 'learner-profile/learner-info.php' );
 
 			}
 		}
@@ -140,43 +140,43 @@ 
 	 */
 	public static function user_info( $user ) {
 
-        /**
-         * This hooke fires inside the Sensei_Learner_Profiles::user_info function.
-         * just before the htmls is generated.
-         * @since 1.0.0
-         */
-        do_action( 'sensei_learner_profile_info', $user );
-
-        /**
-         * This filter runs inside the Sensei_Learner_Profiles::user_info function.
-         * Here you can change the user avatar.
-         *
-         * @since 1.0.0
-         *
-         * @param false|string `<img>` $user_avatar
-         */
+		/**
+		 * This hooke fires inside the Sensei_Learner_Profiles::user_info function.
+		 * just before the htmls is generated.
+		 * @since 1.0.0
+		 */
+		do_action( 'sensei_learner_profile_info', $user );
+
+		/**
+		 * This filter runs inside the Sensei_Learner_Profiles::user_info function.
+		 * Here you can change the user avatar.
+		 *
+		 * @since 1.0.0
+		 *
+		 * @param false|string `<img>` $user_avatar
+		 */
 		$learner_avatar = apply_filters( 'sensei_learner_profile_info_avatar', get_avatar( $user->ID, 120 ), $user->ID );
 
-        /**
-         * This filter runs inside the Sensei_Learner_Profiles::user_info function.
-         * Here you can change the learner profile user display name.
-         * @since 1.0.0
-         *
-         * @param string $user_display_name
-         * @param string $user_id
-         */
+		/**
+		 * This filter runs inside the Sensei_Learner_Profiles::user_info function.
+		 * Here you can change the learner profile user display name.
+		 * @since 1.0.0
+		 *
+		 * @param string $user_display_name
+		 * @param string $user_id
+		 */
 		$learner_name = apply_filters( 'sensei_learner_profile_info_name', $user->display_name, $user->ID );
 
-        /**
-         * This filter runs inside the Sensei_Learner_Profiles::user_info function.
-         * With this filter can change the users description on the learner user info
-         * output.
-         *
-         * @since 1.0.0
-         *
-         * @param string $user_description
-         * @param string $user_id
-         */
+		/**
+		 * This filter runs inside the Sensei_Learner_Profiles::user_info function.
+		 * With this filter can change the users description on the learner user info
+		 * output.
+		 *
+		 * @since 1.0.0
+		 *
+		 * @param string $user_description
+		 * @param string $user_id
+		 */
 		$learner_bio = apply_filters( 'sensei_learner_profile_info_bio', $user->description, $user->ID );
 		?>
 
@@ -210,16 +210,16 @@ 
 		return $classes;
 	}
 
-    /**
-     * Deprecate the deprecate_sensei_learner_profile_content hook
-     *
-     * @since 1.9.0
-     */
-    public static function deprecate_sensei_learner_profile_content_hook(){
+	/**
+	 * Deprecate the deprecate_sensei_learner_profile_content hook
+	 *
+	 * @since 1.9.0
+	 */
+	public static function deprecate_sensei_learner_profile_content_hook(){
 
-        sensei_do_deprecated_action( 'sensei_learner_profile_content', '1.9.0', 'sensei_learner_profile_content_before' );
+		sensei_do_deprecated_action( 'sensei_learner_profile_content', '1.9.0', 'sensei_learner_profile_content_before' );
 
-    }
+	}
 
 
 } // End Class

includes/class-sensei-grading-main.php

Indentation +3 added lines, -3 removed lines

@@ -10,7 +10,7 @@ 
  */
 class Sensei_Grading_Main extends WooThemes_Sensei_List_Table {
 
-    public $user_id;
+	public $user_id;
 	public $course_id;
 	public $lesson_id;
 	public $view;
@@ -249,7 +249,7 @@ 
 			$grade = __( 'N/A', 'woothemes-sensei' );
 		}
 
-        $title = Sensei_Learner::get_full_name( $item->user_id );
+		$title = Sensei_Learner::get_full_name( $item->user_id );
 
 		// QuizID to be deprecated
 		$quiz_id = get_post_meta( $item->comment_post_ID, '_lesson_quiz', true );
@@ -299,7 +299,7 @@ 
 	 */
 	public function no_items() {
 
-        _e( 'No submissions found.', 'woothemes-sensei' );
+		_e( 'No submissions found.', 'woothemes-sensei' );
 
 	} // End no_items()
 

includes/class-sensei-analysis-lesson-list-table.php

Indentation +4 added lines, -4 removed lines

@@ -230,9 +230,9 @@ 
 		}
 
 		// Output users data
-        $user_name = Sensei_Learner::get_full_name( $item->user_id );
+		$user_name = Sensei_Learner::get_full_name( $item->user_id );
 
-        if ( !$this->csv_output ) {
+		if ( !$this->csv_output ) {
 			$url = add_query_arg( array( 'page' => $this->page_slug, 'user_id' => $item->user_id, 'course_id' => $this->course_id ), admin_url( 'admin.php' ) );
 
 			$user_name = '<strong><a class="row-title" href="' . esc_url( $url ) . '">' . $user_name . '</a></strong>';
@@ -339,9 +339,9 @@ 
 	 */
 	public function search_button( $text = '' ) {
 
-        $text =  __( 'Search Learners', 'woothemes-sensei' );
+		$text =  __( 'Search Learners', 'woothemes-sensei' );
 
-        return $text;
+		return $text;
 
 	}
 } // End Class

includes/class-sensei-learner.php

Indentation +31 added lines, -31 removed lines

@@ -13,46 +13,46 @@
  */
 class Sensei_Student{
 
-    /**
-     * Get the students full name
-     *
-     * This function replaces Sensei_Learner_Managment->get_learner_full_name
-     * @since 1.9.0
-     *
-     * @param $user_id
-     * @return bool|mixed|void
-     */
-    public static function get_full_name( $user_id ){
+	/**
+	 * Get the students full name
+	 *
+	 * This function replaces Sensei_Learner_Managment->get_learner_full_name
+	 * @since 1.9.0
+	 *
+	 * @param $user_id
+	 * @return bool|mixed|void
+	 */
+	public static function get_full_name( $user_id ){
 
-        $full_name = '';
+		$full_name = '';
 
-        if( empty( $user_id ) || ! ( 0 < intval( $user_id ) )
-            || !( get_userdata( $user_id ) ) ){
-            return false;
-        }
+		if( empty( $user_id ) || ! ( 0 < intval( $user_id ) )
+			|| !( get_userdata( $user_id ) ) ){
+			return false;
+		}
 
-        // get the user details
-        $user = get_user_by( 'id', $user_id );
+		// get the user details
+		$user = get_user_by( 'id', $user_id );
 
-        if( ! empty( $user->first_name  ) && ! empty( $user->last_name  )  ){
+		if( ! empty( $user->first_name  ) && ! empty( $user->last_name  )  ){
 
-            $full_name = trim( $user->first_name   ) . ' ' . trim( $user->last_name  );
+			$full_name = trim( $user->first_name   ) . ' ' . trim( $user->last_name  );
 
-        }else{
+		}else{
 
-            $full_name =  $user->display_name;
+			$full_name =  $user->display_name;
 
-        }
+		}
 
-        /**
-         * Filter the user full name from the get_learner_full_name function.
-         *
-         * @since 1.8.0
-         * @param $full_name
-         * @param $user_id
-         */
-        return apply_filters( 'sensei_learner_full_name' , $full_name , $user_id );
+		/**
+		 * Filter the user full name from the get_learner_full_name function.
+		 *
+		 * @since 1.8.0
+		 * @param $full_name
+		 * @param $user_id
+		 */
+		return apply_filters( 'sensei_learner_full_name' , $full_name , $user_id );
 
-    }// end get_full_name
+	}// end get_full_name
 
 }
\ No newline at end of file

includes/class-sensei-analysis-course-list-table.php

Indentation +1 added lines, -1 removed lines

@@ -627,7 +627,7 @@
 		$course = get_post( $this->course_id );
 		$report = sanitize_title( $course->post_title ) . '-' . $this->view . 's-overview';
 		if ( $this->user_id ) {
-            $user_name = Sensei_Learner::get_full_name( $this->user_id );
+			$user_name = Sensei_Learner::get_full_name( $this->user_id );
 			$report = sanitize_title( $user_name  ) . '-' . $report;
 		}
 

includes/admin/class-sensei-welcome.php

Indentation +39 added lines, -39 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined( 'ABSPATH' ) ) {
-    exit; // Exit if accessed directly
+	exit; // Exit if accessed directly
 }
 
 /**
@@ -17,45 +17,45 @@ 
 
 	/**
 	 * Hook in tabs.
-     * @since 1.8.0
+	 * @since 1.8.0
 	 */
 	public function __construct() {
 
-        add_action( 'admin_menu', array( $this, 'admin_menus') );
+		add_action( 'admin_menu', array( $this, 'admin_menus') );
 		add_action( 'admin_head', array( $this, 'admin_head' ) );
 
 	}
 
-    /**
-     * Sends user to the welcome page on first activation.
-     *
-     * Hooked into activated_plugin
-     * @since 1.8.0
-     */
-    public static function redirect( $plugin ) {
+	/**
+	 * Sends user to the welcome page on first activation.
+	 *
+	 * Hooked into activated_plugin
+	 * @since 1.8.0
+	 */
+	public static function redirect( $plugin ) {
 
-        // Bail if activating from network, or bulk, or within an iFrame
-        if ( is_network_admin() || isset( $_GET['activate-multi'] ) || defined( 'IFRAME_REQUEST' ) ) {
+		// Bail if activating from network, or bulk, or within an iFrame
+		if ( is_network_admin() || isset( $_GET['activate-multi'] ) || defined( 'IFRAME_REQUEST' ) ) {
 
-            return;
+			return;
 
-        }
-        // don't run for upgrades and for pages already on the welcome screen
-        if ( ( isset( $_GET['action'] ) && 'upgrade-plugin' == $_GET['action'] )
-            || ( ! empty( $_GET['page'] ) && $_GET['page'] === 'sensei-welcome' ) ) {
+		}
+		// don't run for upgrades and for pages already on the welcome screen
+		if ( ( isset( $_GET['action'] ) && 'upgrade-plugin' == $_GET['action'] )
+			|| ( ! empty( $_GET['page'] ) && $_GET['page'] === 'sensei-welcome' ) ) {
 
-            return;
+			return;
 
-        }
+		}
 
-        wp_redirect( admin_url( 'index.php?page=sensei-welcome' ) );
-        exit;
-    }
+		wp_redirect( admin_url( 'index.php?page=sensei-welcome' ) );
+		exit;
+	}
 
 	/**
 	 * Add admin menus/screens.
-     *
-     * @since 1.8.0
+	 *
+	 * @since 1.8.0
 	 */
 	public function admin_menus() {
 
@@ -65,17 +65,17 @@ 
 
 		$welcome_page_name  = __( 'Sensei Activation', 'woothemes-sensei' );
 		$welcome_page_title = __( 'Welcome to Sensei', 'woothemes-sensei' );
-        add_dashboard_page( $welcome_page_title, $welcome_page_name, 'manage_options', 'sensei-welcome', array( $this, 'welcome_screen' ) );
+		add_dashboard_page( $welcome_page_title, $welcome_page_name, 'manage_options', 'sensei-welcome', array( $this, 'welcome_screen' ) );
 
 	}
 
-    /**
-     * Output the Welcome  screen.
-     *
-     * @since 1.8.0
-     */
-    public function welcome_screen() {
-        ?>
+	/**
+	 * Output the Welcome  screen.
+	 *
+	 * @since 1.8.0
+	 */
+	public function welcome_screen() {
+		?>
         <div class="wrap about-wrap">
 
             <?php  $this->intro(); ?>
@@ -128,13 +128,13 @@ 
             </div>
         </div>
     <?php
-    }
+	}
 
 	/**
 	 * Add styles just for this page, and remove dashboard page links.
 	 */
 	public function admin_head() {
-        // remove the menu page so it is not visible in the admin side bar
+		// remove the menu page so it is not visible in the admin side bar
 		remove_submenu_page( 'index.php', 'sensei-welcome' );
 		?>
 		<style type="text/css">
@@ -258,7 +258,7 @@ 
 
 		// Random tweet - must be kept to 102 chars to "fit"
 		$tweets        = array(
-            'I\'ve just installed Sensei - A premium Learning Management plugin for #WordPress.'
+			'I\'ve just installed Sensei - A premium Learning Management plugin for #WordPress.'
 		);
 		shuffle( $tweets );
 		?>
@@ -280,11 +280,11 @@ 
 
 		<div class="sensei-badge">
             <?php
-                _e('Sensei by WooThemes','woothemes-sensei');
-                echo '<br />';
+				_e('Sensei by WooThemes','woothemes-sensei');
+				echo '<br />';
 
-                printf( __( 'Version %s', 'woothemes-sensei' ), Sensei()->version );
-            ?>
+				printf( __( 'Version %s', 'woothemes-sensei' ), Sensei()->version );
+			?>
         </div>
 
 		<p class="sensei-actions">

includes/class-sensei-learners-main.php

Indentation +24 added lines, -24 removed lines

@@ -205,13 +205,13 @@ 
 
 	/**
 	 * Generates content for a single row of the table in the user management
-     * screen.
-     *
+	 * screen.
+	 *
 	 * @since  1.7.0
-     *
+	 *
 	 * @param object $item The current item
-     *
-     * @return void
+	 *
+	 * @return void
 	 */
 	protected function get_row_data( $item ) {
 		global $wp_version;
@@ -219,8 +219,8 @@ 
 		switch ( $this->view ) {
 			case 'learners' :
 
-                // in this case the item passed in is actually the users activity on course of lesson
-                $user_activity = $item;
+				// in this case the item passed in is actually the users activity on course of lesson
+				$user_activity = $item;
 				$post_id = false;
 
 				if( $this->lesson_id ) {
@@ -239,30 +239,30 @@ 
 
 				if( 'complete' == $user_activity->comment_approved || 'graded' == $user_activity->comment_approved || 'passed' == $user_activity->comment_approved ) {
 
-                    $status_html = '<span class="graded">' .__( 'Completed', 'woothemes-sensei' ) . '</span>';
+					$status_html = '<span class="graded">' .__( 'Completed', 'woothemes-sensei' ) . '</span>';
 
 				} else {
 
-                    $status_html = '<span class="in-progress">' . __( 'In Progress', 'woothemes-sensei' ) . '</span>';
+					$status_html = '<span class="in-progress">' . __( 'In Progress', 'woothemes-sensei' ) . '</span>';
 
 				}
 
-                $title = Sensei_Learner::get_full_name( $user_activity->user_id );
+				$title = Sensei_Learner::get_full_name( $user_activity->user_id );
 				$a_title = sprintf( __( 'Edit &#8220;%s&#8221;' ), $title );
 
-                /**
-                 * sensei_learners_main_column_data filter
-                 *
-                 * This filter runs on the learner management screen for a specific course.
-                 * It provides the learner row column details.
-                 *
-                 * @param array $columns{
-                 *   type string $title
-                 *   type string $date_started
-                 *   type string $course_status (completed, started etc)
-                 *   type html $action_buttons
-                 * }
-                 */
+				/**
+				 * sensei_learners_main_column_data filter
+				 *
+				 * This filter runs on the learner management screen for a specific course.
+				 * It provides the learner row column details.
+				 *
+				 * @param array $columns{
+				 *   type string $title
+				 *   type string $date_started
+				 *   type string $course_status (completed, started etc)
+				 *   type html $action_buttons
+				 * }
+				 */
 				$column_data = apply_filters( 'sensei_learners_main_column_data', array(
 						'title' => '<strong><a class="row-title" href="' . admin_url( 'user-edit.php?user_id=' . $user_activity->user_id ) . '" title="' . esc_attr( $a_title ) . '">' . $title . '</a></strong>',
 						'date_started' => get_comment_meta( $user_activity->comment_ID, 'start', true),
@@ -292,7 +292,7 @@ 
 
 			case 'courses' :
 			default:
-                $course_learners = Sensei_Utils::sensei_check_for_activity( apply_filters( 'sensei_learners_course_learners', array( 'post_id' => $item->ID, 'type' => 'sensei_course_status', 'status' => 'any' ) ) );
+				$course_learners = Sensei_Utils::sensei_check_for_activity( apply_filters( 'sensei_learners_course_learners', array( 'post_id' => $item->ID, 'type' => 'sensei_course_status', 'status' => 'any' ) ) );
 				$title = get_the_title( $item );
 				$a_title = sprintf( __( 'Edit &#8220;%s&#8221;' ), $title );
 

includes/class-sensei-messages.php

Indentation +222 added lines, -222 removed lines

@@ -21,7 +21,7 @@ 
 	 * @since  1.6.0
 	 */
 	public function __construct () {
-        $this->token = 'messages';
+		$this->token = 'messages';
 		$this->post_type = 'sensei_message';
 		$this->meta_fields = array( 'sender', 'receiver' );
 
@@ -36,11 +36,11 @@ 
 		// Monitor when new reply is posted
 		add_action( 'comment_post', array( $this, 'message_reply_received' ), 10, 1 );
 
-        // Block WordPress from sending comment update emails for the messages post type
-        add_filter('comment_notification_recipients', array( $this, 'stop_wp_comment_emails' ),  20, 2  );
+		// Block WordPress from sending comment update emails for the messages post type
+		add_filter('comment_notification_recipients', array( $this, 'stop_wp_comment_emails' ),  20, 2  );
 
-        // Block WordPress from sending comment moderator emails on the sensei messages post types
-        add_filter('comment_moderation_recipients', array( $this, 'stop_wp_comment_emails' ),  20, 2  );
+		// Block WordPress from sending comment moderator emails on the sensei messages post types
+		add_filter('comment_moderation_recipients', array( $this, 'stop_wp_comment_emails' ),  20, 2  );
 
 		// Process saving of message posts
 		add_action( 'save_post', array( $this, 'save_message' ) );
@@ -48,20 +48,20 @@ 
 		// Add message links to courses & lessons
 		add_action( 'sensei_single_course_content_inside_before', array( $this, 'send_message_link' ), 35 );
 
-        // add message link to lesson
-        add_action( 'sensei_single_lesson_content_inside_before', array( $this, 'send_message_link' ), 30, 2 );
+		// add message link to lesson
+		add_action( 'sensei_single_lesson_content_inside_before', array( $this, 'send_message_link' ), 30, 2 );
 
-        // add message link to lesson
-        add_action( 'sensei_single_quiz_questions_before', array( $this, 'send_message_link' ), 10, 2 );
+		// add message link to lesson
+		add_action( 'sensei_single_quiz_questions_before', array( $this, 'send_message_link' ), 10, 2 );
 
 		// Hide messages and replies from users who do not have access
-        add_action( 'template_redirect', array( $this, 'message_login' ), 10, 1 );
-        add_action( 'pre_get_posts', array( $this, 'message_list' ), 10, 1 );
-        add_filter( 'the_title', array( $this, 'message_title' ), 10, 2 );
-        add_filter( 'the_content', array( $this, 'message_content' ), 10, 1 );
-        add_filter( 'comments_array', array( $this, 'message_replies' ), 100, 1 );
-        add_filter( 'get_comments_number', array( $this, 'message_reply_count' ), 100, 2 );
-        add_filter( 'comments_open', array( $this, 'message_replies_open' ), 100, 2 );
+		add_action( 'template_redirect', array( $this, 'message_login' ), 10, 1 );
+		add_action( 'pre_get_posts', array( $this, 'message_list' ), 10, 1 );
+		add_filter( 'the_title', array( $this, 'message_title' ), 10, 2 );
+		add_filter( 'the_content', array( $this, 'message_content' ), 10, 1 );
+		add_filter( 'comments_array', array( $this, 'message_replies' ), 100, 1 );
+		add_filter( 'get_comments_number', array( $this, 'message_reply_count' ), 100, 2 );
+		add_filter( 'comments_open', array( $this, 'message_replies_open' ), 100, 2 );
 	} // End __construct()
 
 	public function add_menu_item() {
@@ -162,8 +162,8 @@ 
 	public function send_message_link( $post_id = 0, $user_id = 0 ) {
 		global  $post;
 
-        // only show the link for the allowed post types:
-        $allowed_post_types = array('lesson', 'course', 'quiz');
+		// only show the link for the allowed post types:
+		$allowed_post_types = array('lesson', 'course', 'quiz');
 		if ( ! in_array( get_post_type() , $allowed_post_types ) ) {
 
 			return;
@@ -186,8 +186,8 @@ 
 				} elseif( 'course' == $post->post_type ) {
 					$contact_button_text = __( 'Contact Course Teacher', 'woothemes-sensei' );
 				}else{
-                    $contact_button_text = __( 'Contact Teacher', 'woothemes-sensei' );
-                }
+					$contact_button_text = __( 'Contact Teacher', 'woothemes-sensei' );
+				}
 
 				$html .= '<p><a class="button send-message-button" href="' . esc_url($href) . '#private_message">' . $contact_button_text . '</a></p>';
 			}
@@ -212,19 +212,19 @@ 
 
 		if( ! isset( $post->ID ) ) return $html;
 
-        //confirm private message
-        $confirmation = '';
-        if( isset( $_GET[ 'send' ] ) && 'complete' == $_GET[ 'send' ] ) {
+		//confirm private message
+		$confirmation = '';
+		if( isset( $_GET[ 'send' ] ) && 'complete' == $_GET[ 'send' ] ) {
 
-            $confirmation_message = __('Your private message has been sent.', 'woothemes-sensei');
-            $confirmation = '<div class="sensei-message tick">' . $confirmation_message . '</div>';
+			$confirmation_message = __('Your private message has been sent.', 'woothemes-sensei');
+			$confirmation = '<div class="sensei-message tick">' . $confirmation_message . '</div>';
 
-        }
+		}
 
 		$html .= '<h3 id="private_message">' . __( 'Send Private Message', 'woothemes-sensei' ) . '</h3>';
-        $html .= '<p>';
-        $html .=  $confirmation;
-        $html .= '</p>';
+		$html .= '<p>';
+		$html .=  $confirmation;
+		$html .= '</p>';
 		$html .= '<form name="contact-teacher" action="" method="post" class="contact-teacher">';
 			$html .= '<p class="form-row form-row-wide">';
 				$html .= '<textarea name="contact_message" placeholder="' . __( 'Enter your private message.', 'woothemes-sensei' ) . '"></textarea>';
@@ -255,7 +255,7 @@ 
 	public function message_reply_received( $comment_id = 0 ) {
 
 		// Get comment object
-    	$comment = get_comment( $comment_id );
+		$comment = get_comment( $comment_id );
 
 		if( is_null( $comment ) ) return;
 
@@ -270,87 +270,87 @@ 
 		do_action( 'sensei_private_message_reply', $comment, $message );
 	}
 
-    /**
-     * This function stops WordPress from sending the default comment update emails.
-     *
-     * This function is hooked into comment_notification_recipients. It will simply return
-     * an empty array if the current passed in comment is on a message post type.
-     *
-     * @param array $emails
-     * @param int $comment_id
-     * @return array;
-     */
-    public function stop_wp_comment_emails( $emails , $comment_id ){
+	/**
+	 * This function stops WordPress from sending the default comment update emails.
+	 *
+	 * This function is hooked into comment_notification_recipients. It will simply return
+	 * an empty array if the current passed in comment is on a message post type.
+	 *
+	 * @param array $emails
+	 * @param int $comment_id
+	 * @return array;
+	 */
+	public function stop_wp_comment_emails( $emails , $comment_id ){
 
-        $comment = get_comment( $comment_id );
-        if( isset( $comment->comment_post_ID ) &&
-            'sensei_message' == get_post_type( $comment->comment_post_ID )  ){
+		$comment = get_comment( $comment_id );
+		if( isset( $comment->comment_post_ID ) &&
+			'sensei_message' == get_post_type( $comment->comment_post_ID )  ){
 
-            // empty the emails array to ensure no emails are sent for this comment
-            $emails = array();
+			// empty the emails array to ensure no emails are sent for this comment
+			$emails = array();
 
-        }
-        return $emails;
+		}
+		return $emails;
 
-    }// end stop_wp_comment_emails
+	}// end stop_wp_comment_emails
 
 	/**
-     * Save new message post
-     * @param  integer $sender_id   ID of sender
-     * @param  integer $receiver_id ID of receiver
-     * @param  string  $message     Message content
-     * @param  string  $post_id     ID of post related to message
-     * @return mixed                Message ID on success, boolean false on failure
-     */
-    private function save_new_message_post( $sender_id = 0, $receiver_id = 0, $message = '', $post_id = 0 ) {
+	 * Save new message post
+	 * @param  integer $sender_id   ID of sender
+	 * @param  integer $receiver_id ID of receiver
+	 * @param  string  $message     Message content
+	 * @param  string  $post_id     ID of post related to message
+	 * @return mixed                Message ID on success, boolean false on failure
+	 */
+	private function save_new_message_post( $sender_id = 0, $receiver_id = 0, $message = '', $post_id = 0 ) {
 
-    	$message_id = false;
+		$message_id = false;
 
-    	if( $sender_id && $receiver_id && $message && $post_id ) {
+		if( $sender_id && $receiver_id && $message && $post_id ) {
 
-    		$title = wp_trim_words( $message, 8, '...' );
+			$title = wp_trim_words( $message, 8, '...' );
 
-    		// Set up post data for message
-	    	$message_data = array(
-	            'post_type'      => $this->post_type,
-	            'post_title'     => esc_html( $title ),
-	            'post_content'   => esc_html( $message ),
-	            'post_status'    => 'publish',
-	            'ping_status'    => 'closed',
-	            'comment_status' => 'open',
-	            'post_excerpt'   => '',
-	            'post_author'	 => intval( $sender_id )
-	        );
+			// Set up post data for message
+			$message_data = array(
+				'post_type'      => $this->post_type,
+				'post_title'     => esc_html( $title ),
+				'post_content'   => esc_html( $message ),
+				'post_status'    => 'publish',
+				'ping_status'    => 'closed',
+				'comment_status' => 'open',
+				'post_excerpt'   => '',
+				'post_author'	 => intval( $sender_id )
+			);
 
-	    	// Insert post
-	        $message_id = wp_insert_post( $message_data );
+			// Insert post
+			$message_id = wp_insert_post( $message_data );
 
-	        if( ! is_wp_error( $message_id ) ) {
+			if( ! is_wp_error( $message_id ) ) {
 
-	        	// Add sender to message meta
-	        	$sender = get_userdata( $sender_id );
-	        	add_post_meta( $message_id, '_sender', $sender->user_login );
+				// Add sender to message meta
+				$sender = get_userdata( $sender_id );
+				add_post_meta( $message_id, '_sender', $sender->user_login );
 
-	        	// Add receiver to message meta
-	        	$receiver = get_userdata( $receiver_id );
-		        add_post_meta( $message_id, '_receiver', $receiver->user_login );
+				// Add receiver to message meta
+				$receiver = get_userdata( $receiver_id );
+				add_post_meta( $message_id, '_receiver', $receiver->user_login );
 
-		        // Add lesson/course ID to message meta
-		        $post = get_post( $post_id );
-		        add_post_meta( $message_id, '_posttype', $post->post_type );
-		        add_post_meta( $message_id, '_post', $post->ID );
+				// Add lesson/course ID to message meta
+				$post = get_post( $post_id );
+				add_post_meta( $message_id, '_posttype', $post->post_type );
+				add_post_meta( $message_id, '_post', $post->ID );
 
-		        do_action( 'sensei_new_private_message', $message_id );
+				do_action( 'sensei_new_private_message', $message_id );
 
-		    } else {
+			} else {
 
-		    	$message_id = false;
+				$message_id = false;
 
-		    }
-	    }
+			}
+		}
 
-	    return $message_id;
-    }
+		return $message_id;
+	}
 
 	/**
 	 * Check if user has access to view this message
@@ -389,56 +389,56 @@ 
 		remove_meta_box('commentstatusdiv', $this->post_type, 'normal');
 	}
 
-    /**
-     * Function message_login()
-     *
-     * Only show /messages/* to logged in users, and
-     * redirect logged out users to wp-login.php
-     *
-     * @since 1.9.0
-     * @param  none
-     * @return void
-     */
+	/**
+	 * Function message_login()
+	 *
+	 * Only show /messages/* to logged in users, and
+	 * redirect logged out users to wp-login.php
+	 *
+	 * @since 1.9.0
+	 * @param  none
+	 * @return void
+	 */
 
-    public function message_login () {
+	public function message_login () {
 
-        if ( is_user_logged_in() ) {
+		if ( is_user_logged_in() ) {
 
-            return;
-        }
+			return;
+		}
 
-        $settings = Sensei()->settings->get_settings();
-        if( isset( $settings[ 'my_course_page' ] )
-            && 0 < intval( $settings[ 'my_course_page' ] ) ){
+		$settings = Sensei()->settings->get_settings();
+		if( isset( $settings[ 'my_course_page' ] )
+			&& 0 < intval( $settings[ 'my_course_page' ] ) ){
 
-            $my_courses_page_id = $settings[ 'my_course_page' ];
+			$my_courses_page_id = $settings[ 'my_course_page' ];
 
-            $my_courses_url = get_permalink($my_courses_page_id);
+			$my_courses_url = get_permalink($my_courses_page_id);
 
-        }
+		}
 
-        if ( is_single() && is_singular( $this->post_type )
-            || is_post_type_archive( $this->post_type ) ) {
+		if ( is_single() && is_singular( $this->post_type )
+			|| is_post_type_archive( $this->post_type ) ) {
 
-            if ( isset($my_courses_url) ) {
+			if ( isset($my_courses_url) ) {
 
-                wp_redirect($my_courses_url, 303);
-                exit;
-            }
+				wp_redirect($my_courses_url, 303);
+				exit;
+			}
 
-            else {
+			else {
 
-                wp_redirect(home_url('/wp-login.php'), 303);
-                exit;
-            }
+				wp_redirect(home_url('/wp-login.php'), 303);
+				exit;
+			}
 
-        }
-    }
+		}
+	}
 	/**
-     * Only show allowed messages in messages archive
-     * @param  WP_Query $query Original query
-     * @return void
-     */
+	 * Only show allowed messages in messages archive
+	 * @param  WP_Query $query Original query
+	 * @return void
+	 */
 	public function message_list( $query ) {
 		global $current_user;
 
@@ -555,17 +555,17 @@ 
 		return $open;
 	}
 
-    /**
-     * Print outthe message was sent by $sender_username on the
-     *
-     * @since 1.9.0
-     */
-    public static function the_message_sent_by_title(){
+	/**
+	 * Print outthe message was sent by $sender_username on the
+	 *
+	 * @since 1.9.0
+	 */
+	public static function the_message_sent_by_title(){
 
-        $sender_username = get_post_meta( get_the_ID() , '_sender', true );
-        if( $sender_username ) {
+		$sender_username = get_post_meta( get_the_ID() , '_sender', true );
+		if( $sender_username ) {
 
-            $sender = get_user_by( 'login', $sender_username ); ?>
+			$sender = get_user_by( 'login', $sender_username ); ?>
 
             <p class="message-meta">
                 <small>
@@ -577,41 +577,41 @@ 
 
         <?php }
 
-    }
+	}
 
-    /**
-     * sensei_single_title output for single page title
-     * @since  1.1.0
-     * @return void
-     * @deprecate
-     */
-    public static function the_title() {
+	/**
+	 * sensei_single_title output for single page title
+	 * @since  1.1.0
+	 * @return void
+	 * @deprecate
+	 */
+	public static function the_title() {
 
-        global $post;
+		global $post;
 
-        $content_post_id = get_post_meta( $post->ID, '_post', true );
-        if( $content_post_id ) {
-            $title = sprintf( __( 'Re: %1$s', 'woothemes-sensei' ), '<a href="' . get_permalink( $content_post_id ) . '">' . get_the_title( $content_post_id ) . '</a>' );
-        } else {
-            $title = get_the_title( $post->ID );
-        }
+		$content_post_id = get_post_meta( $post->ID, '_post', true );
+		if( $content_post_id ) {
+			$title = sprintf( __( 'Re: %1$s', 'woothemes-sensei' ), '<a href="' . get_permalink( $content_post_id ) . '">' . get_the_title( $content_post_id ) . '</a>' );
+		} else {
+			$title = get_the_title( $post->ID );
+		}
 
-        ?>
+		?>
         <header>
 
             <h1>
 
                 <?php
-                /**
-                 * Filter Sensei single title
-                 *
-                 * @since 1.8.0
-                 * @param string $title
-                 * @param string $template
-                 * @param string $post_type
-                 */
-                echo apply_filters( 'sensei_single_title', $title, $post->post_type );
-                ?>
+				/**
+				 * Filter Sensei single title
+				 *
+				 * @since 1.8.0
+				 * @param string $title
+				 * @param string $template
+				 * @param string $post_type
+				 */
+				echo apply_filters( 'sensei_single_title', $title, $post->post_type );
+				?>
 
             </h1>
 
@@ -619,52 +619,52 @@ 
 
         <?php
 
-    } // End sensei_single_title()
+	} // End sensei_single_title()
 
-    /**
-     * Generates the my messages
-     * archive header.
-     *
-     * @since 1.9.0
-     *
-     * @return string
-     */
-    public static function the_archive_header( ){
+	/**
+	 * Generates the my messages
+	 * archive header.
+	 *
+	 * @since 1.9.0
+	 *
+	 * @return string
+	 */
+	public static function the_archive_header( ){
 
-        $html = '';
-        $html .= '<header class="archive-header"><h1>';
-        $html .= __( 'My Messages', 'woothemes-sensei' );
-        $html .= '</h1></header>';
+		$html = '';
+		$html .= '<header class="archive-header"><h1>';
+		$html .= __( 'My Messages', 'woothemes-sensei' );
+		$html .= '</h1></header>';
 
-        /**
-         * Filter the sensei messages archive title.
-         * @since 1.0.0
-         */
-        echo apply_filters( 'sensei_message_archive_title', $html );
+		/**
+		 * Filter the sensei messages archive title.
+		 * @since 1.0.0
+		 */
+		echo apply_filters( 'sensei_message_archive_title', $html );
 
-    } // get_archive_header()
+	} // get_archive_header()
 
-    /**
-     * Output the title for a message given the post_id.
-     *
-     * @since 1.9.0
-     * @param $post_id
-     */
-    public static function the_message_title( $message_post_id ){
+	/**
+	 * Output the title for a message given the post_id.
+	 *
+	 * @since 1.9.0
+	 * @param $post_id
+	 */
+	public static function the_message_title( $message_post_id ){
 
-        $content_post_id = get_post_meta( $message_post_id, '_post', true );
+		$content_post_id = get_post_meta( $message_post_id, '_post', true );
 
-        if( $content_post_id ) {
+		if( $content_post_id ) {
 
-            $title = sprintf( __( 'Re: %1$s', 'woothemes-sensei' ), get_the_title( $content_post_id ) );
+			$title = sprintf( __( 'Re: %1$s', 'woothemes-sensei' ), get_the_title( $content_post_id ) );
 
-        } else {
+		} else {
 
-            $title = get_the_title( $message_post_id );
+			$title = get_the_title( $message_post_id );
 
-        }
+		}
 
-        ?>
+		?>
         <h2>
             <a href="<?php esc_url( get_permalink( $message_post_id ) );?>">
                 <?php echo  $title; ?>
@@ -673,21 +673,21 @@ 
         </h2>
 
         <?php
-    } //end the_message_header
+	} //end the_message_header
 
-    /**
-     * Output the message sender given the post id.
-     *
-     * @param $message_post_id
-     */
-    public  static function the_message_sender( $message_post_id ){
+	/**
+	 * Output the message sender given the post id.
+	 *
+	 * @param $message_post_id
+	 */
+	public  static function the_message_sender( $message_post_id ){
 
-        $sender_username = get_post_meta( $message_post_id, '_sender', true );
-        $sender = get_user_by( 'login', $sender_username );
+		$sender_username = get_post_meta( $message_post_id, '_sender', true );
+		$sender = get_user_by( 'login', $sender_username );
 
-        if( $sender_username && $sender instanceof WP_User ) {
-            $sender_display_name = sprintf( __( 'Sent by %1$s on %2$s.', 'woothemes-sensei' ), $sender->display_name, get_the_date() );
-            ?>
+		if( $sender_username && $sender instanceof WP_User ) {
+			$sender_display_name = sprintf( __( 'Sent by %1$s on %2$s.', 'woothemes-sensei' ), $sender->display_name, get_the_date() );
+			?>
             <p class="message-meta">
                 <small>
                     <em> <?php echo $sender_display_name; ?> </em>
@@ -695,18 +695,18 @@ 
             </p>
 
             <?php
-        } // end if
-
-    } // end the_message_archive_sender
-
-    /**
-     * Link to the users my messages page
-     *
-     * @since 1.9.0
-     */
-    public static function the_my_messages_link(){
-        if( ! Sensei()->settings->get('messages_disable')  ) {
-            ?>
+		} // end if
+
+	} // end the_message_archive_sender
+
+	/**
+	 * Link to the users my messages page
+	 *
+	 * @since 1.9.0
+	 */
+	public static function the_my_messages_link(){
+		if( ! Sensei()->settings->get('messages_disable')  ) {
+			?>
             <p class="my-messages-link-container">
                 <a class="my-messages-link" href="<?php echo get_post_type_archive_link( 'sensei_message' ); ?>"
                    title="<?php _e( 'View & reply to private messages sent to your course & lesson teachers.', 'woothemes-sensei' ); ?>">
@@ -714,8 +714,8 @@ 
                 </a>
             </p>
             <?php
-        }
-    }
+		}
+	}
 
 } // End Class
 

includes/class-sensei-emails.php

Indentation +48 added lines, -48 removed lines

@@ -45,7 +45,7 @@ 
 		add_action( 'sensei_course_status_updated', array( $this, 'learner_completed_course' ), 10, 4 );
 		add_action( 'sensei_course_status_updated', array( $this, 'teacher_completed_course' ), 10, 4 );
 		add_action( 'sensei_user_course_start', array( $this, 'teacher_started_course' ), 10, 2 );
-        add_action( 'sensei_user_lesson_end', array( $this, 'teacher_completed_lesson' ), 10, 2 );
+		add_action( 'sensei_user_lesson_end', array( $this, 'teacher_completed_lesson' ), 10, 2 );
 		add_action( 'sensei_user_quiz_submitted', array( $this, 'teacher_quiz_submitted' ), 10, 5 );
 		add_action( 'sensei_new_private_message', array( $this, 'teacher_new_message' ), 10, 1 );
 		add_action( 'sensei_private_message_reply', array( $this, 'new_message_reply' ), 10, 2 );
@@ -62,9 +62,9 @@ 
 		$this->emails['learner-graded-quiz'] = include( 'emails/class-woothemes-sensei-email-learner-graded-quiz.php' );
 		$this->emails['learner-completed-course'] = include( 'emails/class-woothemes-sensei-email-learner-completed-course.php' );
 		$this->emails['teacher-completed-course'] = include( 'emails/class-woothemes-sensei-email-teacher-completed-course.php' );
-        $this->emails['teacher-started-course'] = include( 'emails/class-woothemes-sensei-email-teacher-started-course.php' );
-        $this->emails['teacher-completed-lesson'] = include( 'emails/class-woothemes-sensei-email-teacher-completed-lesson.php' );
-        $this->emails['teacher-quiz-submitted'] = include( 'emails/class-woothemes-sensei-email-teacher-quiz-submitted.php' );
+		$this->emails['teacher-started-course'] = include( 'emails/class-woothemes-sensei-email-teacher-started-course.php' );
+		$this->emails['teacher-completed-lesson'] = include( 'emails/class-woothemes-sensei-email-teacher-completed-lesson.php' );
+		$this->emails['teacher-quiz-submitted'] = include( 'emails/class-woothemes-sensei-email-teacher-quiz-submitted.php' );
 		$this->emails['teacher-new-message'] = include( 'emails/class-woothemes-sensei-email-teacher-new-message.php' );
 		$this->emails['new-message-reply'] = include( 'emails/class-woothemes-sensei-email-new-message-reply.php' );
 		$this->emails = apply_filters( 'sensei_email_classes', $this->emails );
@@ -171,20 +171,20 @@ 
 		add_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ) );
 		add_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ) );
 
-        // Send
-        $send_email = true;
+		// Send
+		$send_email = true;
 
-        /**
-         * Filter Sensei's ability to send out emails.
-         *
-         * @since 1.8.0
-         * @param bool $send_email default true
-         */
-        if( apply_filters('sensei_send_emails', $send_email,$to, $subject, $message )  ){
+		/**
+		 * Filter Sensei's ability to send out emails.
+		 *
+		 * @since 1.8.0
+		 * @param bool $send_email default true
+		 */
+		if( apply_filters('sensei_send_emails', $send_email,$to, $subject, $message )  ){
 
-            wp_mail( $to, $subject, $message, $headers, $attachments );
+			wp_mail( $to, $subject, $message, $headers, $attachments );
 
-        }
+		}
 
 		// Unhook filters
 		remove_filter( 'wp_mail_from', array( $this, 'get_from_address' ) );
@@ -326,44 +326,44 @@ 
 		}
 	}
 
-    /**
-     * teacher_completed_lesson()
-     *
-     * Send email to teacher on student completing lesson
-     *
-     * @access public
-     * @return void
-     * @since 1.9.0
-     */
-    function teacher_completed_lesson( $learner_id = 0, $lesson_id = 0 ) {
-
-
-        $send = false;
-
-        if( isset( Sensei()->settings->settings[ 'email_teachers' ] ) ) {
-            if( in_array( 'teacher-completed-lesson', (array) Sensei()->settings->settings[ 'email_teachers' ]) ) {
-                $send = true;
-            }
-        } else {
-            $send = true;
-        }
-
-        if( $send ) {
-            $email = $this->emails['teacher-completed-lesson'];
-            $email->trigger( $learner_id, $lesson_id );
-        }
-    }
+	/**
+	 * teacher_completed_lesson()
+	 *
+	 * Send email to teacher on student completing lesson
+	 *
+	 * @access public
+	 * @return void
+	 * @since 1.9.0
+	 */
+	function teacher_completed_lesson( $learner_id = 0, $lesson_id = 0 ) {
+
+
+		$send = false;
+
+		if( isset( Sensei()->settings->settings[ 'email_teachers' ] ) ) {
+			if( in_array( 'teacher-completed-lesson', (array) Sensei()->settings->settings[ 'email_teachers' ]) ) {
+				$send = true;
+			}
+		} else {
+			$send = true;
+		}
+
+		if( $send ) {
+			$email = $this->emails['teacher-completed-lesson'];
+			$email->trigger( $learner_id, $lesson_id );
+		}
+	}
 
 	/**
 	 * Send email to teacher on quiz submission
 	 *
 	 *
-     * @param int $learner_id
-     * @param int $quiz_id
-     * @param int $grade
-     * @param int $passmark
-     * @param string $quiz_grade_type
-     */
+	 * @param int $learner_id
+	 * @param int $quiz_id
+	 * @param int $grade
+	 * @param int $passmark
+	 * @param string $quiz_grade_type
+	 */
 	function teacher_quiz_submitted( $learner_id = 0, $quiz_id = 0, $grade = 0, $passmark = 0, $quiz_grade_type = 'manual' ) {
 
 		$send = false;