Add toggle to pre-publish panel to publish lessons when course is published

assets/admin/course-pre-publish-panel/course-pre-publish-panel.js

@@ -0,0 +1,42 @@
+/**
+ * WordPress dependencies
+ */
+import { __ } from '@wordpress/i18n';
+import { useEntityProp } from '@wordpress/core-data';
+import { PluginPrePublishPanel } from '@wordpress/edit-post';
+import { ToggleControl } from '@wordpress/components';
+
+/**
+ * Internal dependencies
+ */
+import SenseiIcon from '../../icons/logo-tree.svg';
+
+/**
+ * Course pre-publish panel.
+ */
+export const CoursePrePublishPanel = () => {
+	const [ meta, setMeta ] = useEntityProp( 'postType', 'course', 'meta' );
+	const { sensei_course_publish_lessons: publishLessons } = meta;
+
+	return (
+		<PluginPrePublishPanel
+			title={ __( 'Sensei LMS', 'sensei-lms' ) }
+			icon={ <SenseiIcon height="20" width="20" /> }
+			initialOpen={ true }
+		>
+			<ToggleControl
+				label={ __( 'Publish lessons', 'sensei-lms' ) }
+				help={ __(
+					'Publish lessons when the course is published.',
+					'sensei-lms'
+				) }
+				checked={ publishLessons }
+				onChange={ ( value ) =>
+					setMeta( { ...meta, sensei_course_publish_lessons: value } )
+				}
+			/>
+		</PluginPrePublishPanel>
+	);
+};
+
+export default CoursePrePublishPanel;

assets/admin/course-pre-publish-panel/index.js

@@ -0,0 +1,14 @@
+/**
+ * WordPress dependencies
+ */
+import { registerPlugin } from '@wordpress/plugins';
+
+/**
+ * Internal dependencies
+ */
+import CoursePrePublishPanel from './course-pre-publish-panel';
+
+registerPlugin( 'sensei-course-pre-publish-panel-plugin', {
+	render: CoursePrePublishPanel,
+	icon: null,
+} );

assets/js/admin/course-settings-plugin-sidebar.js

@@ -51,14 +51,14 @@ export const CourseSidebar = () => {
 		<>
 			<PluginSidebarMoreMenuItem
 				target={ pluginSidebarHandle }
-				icon={ <SenseiIcon height="20" width="20" color="#43AF99" /> }
+				icon={ <SenseiIcon height="20" width="20" /> }
 			>
 				{ __( 'Course Settings', 'sensei-lms' ) }
 			</PluginSidebarMoreMenuItem>
 			<PluginSidebar
 				name={ pluginSidebarHandle }
 				title={ __( 'Course Settings', 'sensei-lms' ) }
-				icon={ <SenseiIcon height="20" width="20" color="#43AF99" /> }
+				icon={ <SenseiIcon height="20" width="20" /> }
 			>
 				{ ! hideCoursePricing && <CoursePricingPromoSidebar /> }
 				{ ! hideAccessPeriod && <CourseAccessPeriodPromoSidebar /> }

changelog/update-save-lessons-on-course-save

@@ -0,0 +1,4 @@
+Significance: minor
+Type: added
+
+Add toggle to pre-publish panel to publish associated lessons when the course is published

config/psalm/psalm-baseline.xml

@@ -39,6 +39,12 @@
       <code>DAY_IN_SECONDS</code>
     </UndefinedConstant>
   </file>
+  <file src="includes/admin/class-sensei-course-pre-publish-panel.php">
+    <DocblockTypeContradiction occurrences="2">
+      <code>! self::$instance</code>
+      <code>self::$instance</code>
+    </DocblockTypeContradiction>
+  </file>
   <file src="includes/admin/class-sensei-editor-wizard.php">
     <DocblockTypeContradiction occurrences="2">
       <code>! self::$instance</code>

includes/admin/class-sensei-course-pre-publish-panel.php

@@ -0,0 +1,91 @@
+<?php
+/**
+ * File containing the class Sensei_Course_Pre_Publish_Panel.
+ *
+ * @package sensei-lms
+ */
+
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
+
+/**
+ * Class that handles the pre-publish panel for courses.
+ *
+ * @since 4.5.0
+ */
+class Sensei_Course_Pre_Publish_Panel {
+	/**
+	 * Instance of class.
+	 *
+	 * @var self
+	 */
+	private static $instance;
+
+	/**
+	 * Sensei_Course_Pre_Publish_Panel constructor. Prevents other instances from being created outside of `self::instance()`.
+	 */
+	private function __construct() {
+	}
+
+	/**
+	 * Fetches an instance of the class.
+	 *
+	 * @return self
+	 */
+	public static function instance() {
+		if ( ! self::$instance ) {
+			self::$instance = new self();
+		}
+
+		return self::$instance;
+	}
+
+	/**
+	 * Initializes the class.
+	 */
+	public function init() {
+		add_action( 'enqueue_block_editor_assets', array( $this, 'enqueue_pre_publish_panel_assets' ) );
+		add_action( 'publish_course', array( $this, 'maybe_publish_lessons' ) );
+	}
+
+	/**
+	 * Enqueue pre-publish panel assets.
+	 */
+	public function enqueue_pre_publish_panel_assets() {
+		if ( 'course' !== get_post_type() ) {
+			return;
+		}
+
+		Sensei()->assets->enqueue( 'sensei-course-pre-publish-panel-script', 'admin/course-pre-publish-panel/index.js' );
+	}
+
+	/**
+	 * Maybe publish associated lessons when the course is published.
+	 *
+	 * @param int $course_id Course ID.
+	 */
+	public function maybe_publish_lessons( $course_id ) {
+		if ( ! current_user_can( 'publish_post', $course_id ) ) {
+			return;
+		}
+
+		$publish_lessons = get_post_meta( $course_id, 'sensei_course_publish_lessons', true );
+
+		if ( ! $publish_lessons ) {
+			return;
+		}
+
+		// Publish all draft lessons for this course.
+		$lesson_ids = Sensei()->course->course_lessons( $course_id, 'draft', 'ids' );
+
+		foreach ( $lesson_ids as $lesson_id ) {
+			wp_update_post(
+				array(
+					'ID'          => (int) $lesson_id,
+					'post_status' => 'publish',
+				)
+			);
+		}
+	}
+}

includes/block-patterns/class-sensei-block-patterns.php

@@ -45,7 +45,7 @@ public function init() {
 	}
 
 	/**
-	 * Sensei_Editor_Wizard constructor. Prevents other instances from being created outside of `self::instance()`.
+	 * Sensei_Block_Patterns constructor. Prevents other instances from being created outside of `self::instance()`.
 	 */
 	private function __construct() {
 	}
@@ -137,7 +137,7 @@ public function maybe_register_pattern_block_polyfill() {
 			'core/pattern',
 			[
 				'editor_script'   => 'sensei-core-pattern-polyfill-script',
-				'render_callback' => function( $attributes ) {
+				'render_callback' => function ( $attributes ) {
 					if ( empty( $attributes['slug'] ) ) {
 						return '';
 					}

includes/class-sensei-course.php

@@ -694,6 +694,18 @@
 				'auth_callback' => [ $this, 'post_meta_auth_callback' ],
 			]
 		);
+		register_post_meta(
+			'course',
+			'sensei_course_publish_lessons',
+			[
+				'show_in_rest'  => true,
+				'single'        => true,
+				'type'          => 'boolean',
+				'default'       => true,
+				'auth_callback' => [ $this, 'post_meta_auth_callback' ],
+			]
+		);
+
 		/**
 		 * Sets up the meta fields saved on course save in WP admin.
 		 *

includes/class-sensei-data-cleaner.php

@@ -262,6 +262,7 @@ class Sensei_Data_Cleaner {
 		'sensei_payment_complete',
 		'sensei_products_processed',
 		'_sensei_attachment_source_key',
+		'sensei_course_publish_lessons',
 		'sensei_course_video_autocomplete',
 		'sensei_course_video_autopause',
 		'sensei_course_video_required',

includes/class-sensei.php

@@ -658,7 +658,7 @@
 
 			Sensei_No_Users_Table_Relationship::instance()->init();
 			SenseiLMS_Plugin_Updater::init();
-
+			Sensei_Course_Pre_Publish_Panel::instance()->init();
 		} else {
 
 			// Load Frontend Class

tests/unit-tests/admin/test-class-sensei-course-pre-publish-panel.php

@@ -0,0 +1,106 @@
+<?php
+/**
+ * This file contains the Sensei_Course_Pre_Publish_Panel_Test class.
+ *
+ * @package sensei
+ */
+
+/**
+ * Tests for Sensei_Course_Pre_Publish_Panel class.
+ */
+class Sensei_Sensei_Course_Pre_Publish_Panel_Test extends WP_UnitTestCase {
+	use Sensei_Test_Login_Helpers;
+
+	/**
+	 * Factory for setting up testing data.
+	 *
+	 * @var Sensei_Factory
+	 */
+	protected $factory;
+
+	/**
+	 * Course ID.
+	 *
+	 * @var int
+	 */
+	private $course_id;
+
+	/**
+	 * Lesson ID.
+	 *
+	 * @var int
+	 */
+	private $lesson_id;
+
+	public function setUp(): void {
+		parent::setUp();
+
+		$this->factory   = new Sensei_Factory();
+		$this->course_id = $this->factory->course->create();
+		$this->lesson_id = $this->factory->lesson->create(
+			[
+				'post_status' => 'draft',
+				'meta_input'  => [
+					'_lesson_course' => $this->course_id,
+				],
+			]
+		);
+	}
+
+	public function tearDown(): void {
+		parent::tearDown();
+
+		$this->factory->tearDown();
+	}
+
+	/**
+	 * Lessons aren't published if the user doesn't have sufficient permissions.
+	 *
+	 *  @covers Sensei_Course_Pre_Publish_Panel::maybe_publish_lessons
+	 */
+	public function testMaybePublishLessons_InsufficientPermissions_DoesNotPublishLessons() {
+		/* Arrange */
+		$this->login_as_student();
+		update_post_meta( $this->course_id, 'sensei_course_publish_lessons', true );
+
+		/* Act */
+		Sensei_Course_Pre_Publish_Panel::instance()->maybe_publish_lessons( $this->course_id );
+
+		/* Assert */
+		$this->assertEquals( 'draft', get_post_status( $this->lesson_id ) );
+	}
+
+	/**
+	 * Lessons aren't published if the user has sufficient permissions but the meta value is false.
+	 *
+	 *  @covers Sensei_Course_Pre_Publish_Panel::maybe_publish_lessons
+	 */
+	public function testMaybePublishLessons_MetaIsFalse_DoesNotPublishLessons() {
+		/* Arrange */
+		$this->login_as_admin();
+		update_post_meta( $this->course_id, 'sensei_course_publish_lessons', false );
+
+		/* Act */
+		Sensei_Course_Pre_Publish_Panel::instance()->maybe_publish_lessons( $this->course_id );
+
+		/* Assert */
+		$this->assertEquals( 'draft', get_post_status( $this->lesson_id ) );
+	}
+
+	/**
+	 * Lessons are published if the user has sufficient permissions and the meta value is true.
+	 *
+	 *  @covers Sensei_Course_Pre_Publish_Panel::maybe_publish_lessons
+	 */
+	public function testMaybePublishLessons_SufficientPermissionsAndMetaIsTrue_DoesPublishLessons() {
+		/* Arrange */
+		$this->login_as_admin();
+		update_post_meta( $this->course_id, 'sensei_course_publish_lessons', true );
+
+		/* Act */
+		Sensei_Course_Pre_Publish_Panel::instance()->maybe_publish_lessons( $this->course_id );
+
+		/* Assert */
+		$this->assertEquals( 'publish', get_post_status( $this->lesson_id ) );
+	}
+}

webpack.config.js

@@ -89,6 +89,7 @@ const files = [
 	'blocks/email-editor.js',
 	'css/email-notifications/email-editor-style.scss',
 	'css/email-notifications/email-style.scss',
+	'admin/course-pre-publish-panel/index.js',
 	'admin/editor-wizard/index.js',
 	'admin/editor-wizard/style.scss',
 	'admin/tour/course-tour/index.js',