WPLMS | Filters

WPLMS Theme :

wplms_allinstructors : Filter on Query arguments for All Instructors template.

wplms_sidebar : Filter on Sidebar which is to be shown in Courses, Pages, posts etc.

wplms_instructor_courses_style : Filter on featured block style name (course2, course...) for instructing courses

wplms_certificate_code_user_id : Certificate validation, Filter on certificate code to return User ID

wplms_certificate_code_course_id : Certificate validation, Filter on certificate code to return Course ID

wplms_certificate_code_template_id : Certificate validation, Filter on certificate code to return Template ID

wplms_certificate_heading : Default certificate title

wplms_certificate_sub_heading : Default certificate sub heading

wplms_certificate_before_course_title : Default certificate text

bp_course_admin_before_course_students_list : Filters array of Student IDs in a course in course - admin - members section.

wplms_curriculum_course_link : Course - Curriculum : Filters flag value, if returns 1 then the items (units/quizzes) in Course curriculum appear with direct links.

wplms_curriculum_course_lesson : Course - Curriculum : Filters individual Unit html in Course - Curriculum. Accepts 1 more argument as Unit ID

wplms_curriculum_time_filter : Course - Curriculum : Filters the time display html for every unit. Accepts 1 more argument that is the time value saved in Unit duration meta field.

wplms_course_instructors : Filters out instructors IDs for a course. Used in Coauthor plus integration. Accepts 1 more argument, the ID of the course.

wplms_create_course_settings : Filters out course settings array and their stored/default value

wplms_frontend_create_course_pricing : Filters for Course pricing setting with their stored/defaut value

wplms_front_end_pricing : Flag which enables/disables the pricing section from the front end course creation page.

wplms_frontend_cpt_query : Modifies WP arguments for loading list of units,quizzes. Used in Instructor privacy and Linkage.

wplms_front_end_course_delete : Filters flag which enables course deletion via front end.

wplms_logo_url : Filters and returns Logo image link

wplms-mobile-menu : Filter on Mobile Menu arguments

wplms-top-menu : Filter on Mobile top arguments

wplms-main-menu : Filter on Mobile main arguments

wplms_customizer_config : Filter on Customizer config, can be used to add custom control in theme customiser

wplms_pmpro_course_check : Filter on user expiration timestamp for course if course is subscribed via PMPro membership

vibe_breadcrumbs_show_title : Filters Flag which displays current page title in breadcrumb, return 0 to disable.

wplms_unit_print_button : Filter Print button html on certificate and unit pages

wplms_registeration_page : Filters registration page link html in the header

wplms_instructing_courses_endpoint : Filters instructing courses end point, default set to 'instructing-courses', append this end point on a authors page to get the list of courses published by the author.

wplms_course_stats_list : Filters download stats options

wplms_course_status : Filters out course status across the setup

wplms_notes_dicussion_args : Filters out WP Query arguments on notes and discussion

vibe_font_query_args : Filters out Font query arguments while loading google fonts

wplms_login_widget_action : Filters the "action" link of Vibe Login dropdown in header. Useful to bypass server restrictions imposed by some hosting companies. example

wplms_in_course_quiz : Filters flag to enable In course quiz

wplms_direct_access_not_allowed : Filters message "Direct access not allowed"

wplms_event_access_flag : Filters access to event content

loop_shop_columns : Filters number of products in one row in shop page

vibe_option_custom_sections : Filters out sections in options panel. Can be used to add custom options or information in options panel.
 

Vibe Course Module :

wplms_calculated_commission_base : Filters calculated commission for instructor for per course sale

wplms_unit_mark_complete : Filters Mark unit complete HTML

wplms_in_course_quiz_args : Filters WP Query arguments for In course quiz

bp_course_wplms_filters : Filters Arguments passed by Filters in course directory

bp_user_can_create_course : Filters true/false based on current user capability

wplms_course_nav_menu : Filters Course Menu . Example

bp_directory_course_search_form : Filters search form HTML

wplms_auto_subscribe : Filters auto-subscribe (user gets subscribed to course on opening the course)for course. Accepts 1 more argument : Course ID

wplms_take_course_page : Filters Take course page url, accepts Course ID as another argument

wplms_finished_course_link : Filters finished course link when course is finished

wplms_course_product_id : Filters Product ID for course take this course button. Arguements : Product ID, Course ID

wplms_private_course_button : Filters link on Private course button

wplms_private_course_button_label : Filters labels on Private course button

wplms_course_details_widget : Filters course details array. example

wplms_generate_quiz_questions : Filters quiz id returns list of questions generated for the user.

wplms_unit_classes : Filters classes added in the units loaded inside the course start page.

wplms_incorrect_quiz_answer : Filters incorrect quiz answer marks.

wplms_correct_quiz_answer : Filters correct quiz answer marks.

wplms_course_drectory_default_order : Filters default course directory order. Used by LMS - settings

bp_course_single_item : Filters classes on single course item in coruse directory

wplms_display_course_instructor_avatar : Filters intructor avatar html

wplms_instructor_meta : Filters instructor meta value html whereever instructor html is generated.

wplms_course_credits_array : Filters the array of multiple payment modes of a course.

wplms_course_marks : Filters out course marks html, example

wplms_course_finished : Filters Course finished message.

wplms_unfinished_unit_quiz_message : Filters unfinished Quiz or Unit message. Accepts Unit ID/Quiz ID as argument

wplms_course_filters_course_cat : Filters out list of categories to be displayed in Course filters widget

wplms_course_filter_admin_args : Filters WP User query arguments for Administrator to be included in Instructors.

Vibe Custom Types :

vibe_course_duration_parameter : Filters course duration parameter, default set to 86400 seconds = 1 days

vibe_drip_duration_parameter : Filters course duration parameter, default set to 86400 seconds = 1 days

vibe_unit_duration_parameter : Filters course duration parameter, default set to 60 seconds = 1 minute

vibe_quiz_duration_parameter : Filters course duration parameter, default set to 60 seconds = 1 minute

vibe_product_duration_parameter : Filters course duration parameter, default set to 86400 seconds = 1 days

vibe_assignment_duration_parameter : Filters course duration parameter, default set to 86400 seconds = 1 days

wplms_post_metabox : Filters metabox arguments for posts

wplms_page_metabox : Filters metabox arguments for pages

wplms_course_metabox : Filters metabox arguments for courses

wplms_course_product_metabox : Filters metabox arguments for Course pricing options

wplms_unit_metabox : Filters metabox arguments for units

wplms_question_metabox : Filters metabox arguments for questions

wplms_quiz_metabox : Filters metabox arguments for quizzes

wplms_testimonial_metabox : Filters metabox arguments for testimonial

wplms_product_metabox : Filters metabox arguments for product

wplms_events_metabox :Filters metabox arguments for Events

wplms_certificate_metabox : Filters metabox arguments for certificate

wplms_assignment_metabox : Filters metabox arguments for assignment

wplms_survey_metabox : Filters metabox arguments for survey

vibe_thumb_featured_image : Filters metabox arguments for featured images

vibe_thumb_rating : Filters metabox arguments for ratings in featured blocks

vibe_thumb_reviews : Filters metabox arguments for reviews in featured blocks

vibe_thumb_instructor_meta : Filters metabox arguments for instructor meta information

vibe_featured_thumbnail_style : Filters HTML generated by featured block

wplms_backend_cpt_query : Filters WP Query for backend posts, used in Instructor privacy and linkage.

WPLMS Front End :

wplms_front_end_group_vars : Filters arguments for Group creation via front end

wplms_front_end_forum_vars : Filters arguments for Forum creation via front end

wplms_front_end_unit_vars : Filters arguments for Unit creation via front end

wplms_front_end_quiz_vars : Filters arguments for Quiz creation via front end

wplms_frontend_new_product : Filters arguments for Product creation via front end

wplms_front_end_question_vars : Filters arguments for questions creation via front end

wplms_front_end_assignment_vars : Filters arguments for assignment creation via front end

wplms_unit_types : Filters available unit types

Execution sequence

This doc explains the sequence of hooks and filters in the theme.

User registration:

wplms_registeration_page : Filters registration page link.

bp_core_activated_user : Hook runs after user has activated account. Runs the first time the user activates the account.

user_register: Hook runs after user is registered.

Course Directory/Taxonomy:

bp_before_directory_course_list

bp_before_course_loop

bp_directory_course_item

bp_after_directory_course_list

Course subscription:

wplms_course_product_id : Filter on Take this course for appropriate course product/membership.

wplms_course_product_puchased : Runs when Course product is purchased

wplms_before_start_course : Before user stats a course

badgeos_wplms_start_course : When a user starts the course

badgeos_wplms_unit_complete : Runs when user marks unit as complete.

badgeos_wplms_submit_assignment : After assignment is submitted

badgeos_wplms_start_quiz : After quiz is started by user

badgeos_wplms_submit_quiz : After quiz is submitted by user

badgeos_wplms_evaluate_quiz : Runs after quiz is evaluated

badgeos_wplms_submit_course : After Course is submitted by user

badgeos_wplms_evaluate_course : After course is evaluated

Important Functions

List of important functions to be used in the theme.

bp_course_get_user_course_status($user_id,$course_id) : Returns course status for a user

bp_course_update_user_course_status($user_id,$course_id,$status) : Updates course status for a user

is_instructor($user_id) : Checks if current user is an instructor

bp_get_course_user_time_left(array('course' =>get_the_ID(),'user'=> get_current_user_id()) : Checks the remaining time of user in course.

wplms_user_course_check($user_id,$course_id): Checks is course is taken by user

wplms_user_course_active_check($user_id,$course_id): Checks is course is taken by user and is not expired

bp_course_add_user_to_course($user_id,$course_id) : Add user to a course.

bp_course_get_user_courses($user_id): Returns array of Course Ids

bp_wplms_get_theme_color: Returns theme color set in theme customiser

bp_course_validate_certificate(array('course_id'=>get_the_ID(),'user_id'=> get_current_user_id()): Validates Course Certificate for a User

bp_get_course_certificate(array('course_id'=>get_the_ID(),'user_id'=> get_current_user_id()): Returns Certificate link if applicable.

get_the_course_time(array('course_id'=>get_the_ID(),user_id'=> get_current_user_id()): Returns time in course remaining

the_course_button($course_ID): Displays Take this course button with course status (start/continue/finished)

bp_course_get_curriculum_units($course_ID): Fetches list of units and quizzes in a course.