From bcce0c183b911678fde8f67e57838a5924297cca Mon Sep 17 00:00:00 2001
From: Ren <18050944+renintw@users.noreply.github.com>
Date: Tue, 10 Sep 2024 13:23:33 +0800
Subject: [PATCH] Add course completion meta field (#2877)
* Add course completion meta fields
* Use the meta on the completed page
---
.../plugins/wporg-learn/inc/post-meta.php | 63 +++++++++++++++++++
.../js/course-completion-meta/index.js | 62 ++++++++++++++++++
.../plugins/wporg-learn/webpack.config.js | 1 +
.../patterns/page-course-complete-content.php | 8 ++-
4 files changed, 132 insertions(+), 2 deletions(-)
create mode 100644 wp-content/plugins/wporg-learn/js/course-completion-meta/index.js
diff --git a/wp-content/plugins/wporg-learn/inc/post-meta.php b/wp-content/plugins/wporg-learn/inc/post-meta.php
index 879a96568..82b16c328 100644
--- a/wp-content/plugins/wporg-learn/inc/post-meta.php
+++ b/wp-content/plugins/wporg-learn/inc/post-meta.php
@@ -28,12 +28,49 @@
* Register all post meta keys.
*/
function register() {
+ register_course_meta();
register_lesson_meta();
register_lesson_plan_meta();
register_workshop_meta();
register_misc_meta();
}
+/**
+ * Register post meta keys for courses.
+ */
+function register_course_meta() {
+ register_post_meta(
+ 'course',
+ '_course_completion_success_message',
+ array(
+ 'description' => __( 'The message displayed to users upon successful course completion.', 'wporg-learn' ),
+ 'type' => 'string',
+ 'single' => true,
+ 'sanitize_callback' => 'sanitize_text_field',
+ 'show_in_rest' => true,
+ 'auth_callback' => function( $allowed, $meta_key, $post_id ) {
+ return current_user_can( 'edit_post', $post_id );
+ },
+ )
+ );
+
+ register_post_meta(
+ 'course',
+ '_course_completion_survey_link',
+ array(
+ 'description' => __( 'The survey link to be shown alongside the completion message.', 'wporg-learn' ),
+ 'type' => 'string',
+ 'single' => true,
+ 'default' => '',
+ 'sanitize_callback' => 'esc_url_raw',
+ 'show_in_rest' => true,
+ 'auth_callback' => function( $allowed, $meta_key, $post_id ) {
+ return current_user_can( 'edit_post', $post_id );
+ },
+ )
+ );
+}
+
/**
* Register post meta keys for lessons.
*/
@@ -655,6 +692,7 @@ function enqueue_editor_assets() {
enqueue_language_meta_assets();
enqueue_lesson_featured_meta_assets();
enqueue_duration_meta_assets();
+ enqueue_course_completion_meta_assets();
}
/**
@@ -760,3 +798,28 @@ function enqueue_duration_meta_assets() {
wp_set_script_translations( 'wporg-learn-duration-meta', 'wporg-learn' );
}
}
+
+/**
+ * Enqueue scripts for the course completion meta block.
+ */
+function enqueue_course_completion_meta_assets() {
+ global $typenow;
+
+ if ( 'course' === $typenow ) {
+ $script_asset_path = get_build_path() . 'course-completion-meta.asset.php';
+ if ( ! file_exists( $script_asset_path ) ) {
+ wp_die( 'You need to run `yarn start` or `yarn build` to build the required assets.' );
+ }
+
+ $script_asset = require( $script_asset_path );
+ wp_enqueue_script(
+ 'wporg-learn-course-completion-meta',
+ get_build_url() . 'course-completion-meta.js',
+ $script_asset['dependencies'],
+ $script_asset['version'],
+ true
+ );
+
+ wp_set_script_translations( 'wporg-learn-course-completion-meta', 'wporg-learn' );
+ }
+}
diff --git a/wp-content/plugins/wporg-learn/js/course-completion-meta/index.js b/wp-content/plugins/wporg-learn/js/course-completion-meta/index.js
new file mode 100644
index 000000000..f2c50b0cc
--- /dev/null
+++ b/wp-content/plugins/wporg-learn/js/course-completion-meta/index.js
@@ -0,0 +1,62 @@
+/**
+ * WordPress dependencies
+ */
+import { PanelRow, TextControl } from '@wordpress/components';
+import { useDispatch, useSelect } from '@wordpress/data';
+import { PluginDocumentSettingPanel } from '@wordpress/edit-post';
+import { __ } from '@wordpress/i18n';
+import { registerPlugin } from '@wordpress/plugins';
+
+const CourseCompletionMeta = () => {
+ const postMetaData = useSelect( ( select ) => select( 'core/editor' ).getEditedPostAttribute( 'meta' ) || {} );
+ const { editPost } = useDispatch( 'core/editor' );
+
+ const message = postMetaData?._course_completion_success_message || '';
+ const link = postMetaData?._course_completion_survey_link || '';
+
+ return (
+
+
+
+ { __(
+ 'These fields customize what is displayed on the Course Completed screen. If left blank, the default values will be applied.',
+ 'wporg-learn'
+ ) }
+