What are the parameters for the Course Progress Outline shortcode?
The [wpcourse_progress] shortcode creates a summary table of all courses that a user is enrolled into, along with their progress for each course and their grade so far. To be able to see their progress, a user needs to be logged in. If the user is not logged in, then a message saying that the user needs to be logged in will be shown.
To create a page with the shortcode, follow these steps:
- Create a page or post by navigating to Posts→Add New for a post or Pages→Add New for a page
- Give your page or post a title
- Insert the course outline shortcode
[wpcourse_progress]
Here's a summary of the shortcode parameters you can add to the shortcode
[wpcourse_progress]
Parameters:
- courses (Optional) A comma-separated list of course IDs to show in the progress. If this is not specified, then all courses that the user is signed up to will be shown.
- course_desc (Optional) Display the course description.
- course_prerequisites (Optional) Display the prerequisites that must be completed before course can be accessed.
- user_progress (Optional) If true, then show a progress bar of the user's current progress for each course they are signed up to. (It can be true or false. By default, it's true).
- user_grade (Optional) If true, then show the user's average grade so far for each course they are signed up to. (It can be true or false. By default, it's true).
- user_quiz_grade (Optional) If true, show quiz grade for unit if unit conatins quiz. (It can be true or false. By default, it's false).
- certificate (Optional) If true, show certificate button if certificates are enabled and course is complete. (It can be true or false. By default, it's false).
Here are some examples of how
[wpcourse_progress] shortcode works:
Example 1:
[wpcourse_progress user_progress="true" user_grade="true" /] Shows all courses a user is signed up to, along with their progress and cumulative grade so far for each course.
Example 2:
[wpcourse_progress /] Does exactly the same as example 1, using the default parameter values.
Example 3:
[wpcourse_progress user_progress="false" user_grade="true" /] Shows all courses a user is signed up to and their cumulative grade so far for each course, but the progress bar for each course is hidden.
Example 4:
[wpcourse_progress user_progress="false" user_grade="false" /] Shows all courses a user is signed up to, but their progress and cumulative grades for each course are hidden.
Example 5:
[wpcourse_progress courses="1,2" user_progress="true" user_grade="true" user_quiz_grade="true" certificate="true" /] Only shows courses with IDs of 1 and 2 if the user is signed to them. If the user is not signed up to any of those courses, then that course is not shown. Their progress and cumulative grade so far for each course is also shown. Quiz grades are shown if quiz is applicable. Certificate button will be displayed.