Overview

Packages

  • Access-Management
  • Analytics
  • Assessment
  • Content
    • Shortcode
  • Core
  • None
  • Users
  • Views
    • Theme-Integration
    • Widgets

Functions

  • sensei_all_access
  • sensei_can_user_view_lesson
  • sensei_check_if_product_is_in_cart
  • sensei_check_prerequisite_course
  • sensei_check_woocommerce_version
  • sensei_complete_lesson_button
  • sensei_course_archive_filter
  • sensei_course_archive_next_link
  • sensei_courses_per_row
  • sensei_do_deprecated_action
  • sensei_get_current_page_url
  • sensei_get_excerpt
  • sensei_get_prev_next_lessons
  • sensei_get_template
  • sensei_get_the_module_status
  • sensei_get_the_module_title
  • sensei_get_the_question_id
  • sensei_has_user_completed_lesson
  • sensei_has_user_completed_prerequisite_lesson
  • sensei_has_user_started_course
  • sensei_have_modules
  • sensei_hex_darker
  • sensei_hex_lighter
  • sensei_is_a_course
  • sensei_is_login_required
  • sensei_light_or_dark
  • sensei_load_template
  • sensei_load_template_part
  • sensei_module_has_lessons
  • sensei_quiz_has_questions
  • sensei_recent_comments_widget_filter
  • sensei_reset_lesson_button
  • sensei_rgb_from_hex
  • sensei_setup_module
  • sensei_setup_the_question
  • sensei_simple_course_price
  • sensei_start_course_form
  • sensei_the_course_results_lessons
  • sensei_the_excerpt
  • sensei_the_lesson_excerpt
  • sensei_the_lesson_status_class
  • sensei_the_module_permalink
  • sensei_the_module_status
  • sensei_the_module_title
  • sensei_the_module_title_attribute
  • sensei_the_my_courses_content
  • sensei_the_question_class
  • sensei_the_question_content
  • sensei_the_single_lesson_meta
  • sensei_user_login_url
  • sensei_wc_add_to_cart
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Hook Reference

Sensei Developer Reference

Packages summary
Functions summary
sensei_all_access

Determine if the current user is and admin that can acess all of Sensei without restrictions

sensei_can_user_view_lesson

Template function to determine if the current user can access the current lesson content being viewed.

sensei_check_if_product_is_in_cart sensei_check_if_product_is_in_cart function.
sensei_check_prerequisite_course sensei_check_prerequisite_course function.
sensei_check_woocommerce_version
sensei_complete_lesson_button

sensei_complete_lesson_button description since 1.0.3

sensei_course_archive_filter sensei_course_archive_filter function.
sensei_course_archive_next_link sensei_course_archive_next_link function.
sensei_courses_per_row

Echo the number of columns (also number of items per row) on the the course archive.

sensei_do_deprecated_action

Provides an interface to allow us to deprecate hooks while still allowing them to work, but giving the developer an error message.

sensei_get_current_page_url Get current url on the frontend
sensei_get_excerpt sensei_get_excerpt Returns the excerpt for the $post
sensei_get_prev_next_lessons

sensei_get_prev_next_lessons Returns the next and previous Lessons in the Course since 1.0.9

sensei_get_template Wrapper function for Sensei_Templates::get_template( $template_name, $args, $path )
sensei_get_the_module_status

Give the current user's lesson progress status Used in the module loop on the courses page

sensei_get_the_module_title

Returns the current module name. This must be used within the Sensei module loop.

sensei_get_the_question_id Output the ID of the current question within the quiz question loop.
sensei_has_user_completed_lesson
sensei_has_user_completed_prerequisite_lesson Determine if a user has completed the pre-requisite lesson.
sensei_has_user_started_course
sensei_have_modules This function checks if the current course has modules.
sensei_hex_darker Hex darker/lighter/contrast functions for colours
sensei_hex_lighter Hex darker/lighter/contrast functions for colours
sensei_is_a_course

Check the given post or post type id is a of the the course post type.

sensei_is_login_required

Checks the settings to see if a user must be logged in to view content

sensei_light_or_dark Detect if we should use a light or dark colour on a background colour
sensei_load_template

This is a wrapper function for Sensei_Templates::get_template It helps simplify templates for designers by removing the class::function call.

sensei_load_template_part

This is a wrapper function for Sensei_Templates::get_part It helps simplify templates for designers by removing the class::function call.

sensei_module_has_lessons

Check if the current module in the modules loop has any lessons. This relies on the global $wp_query. Which will be setup for each module by sensei_the_module(). This function must only be used withing the module lessons loop.

sensei_quiz_has_questions This function can only be run inside the the quiz question lessons loop.
sensei_recent_comments_widget_filter sensei_recent_comments_widget_filter function.
sensei_reset_lesson_button

sensei_reset_lesson_button description since 1.0.3

sensei_rgb_from_hex Hex darker/lighter/contrast functions for colours
sensei_setup_module Setup the next module int the module loop
sensei_setup_the_question This funciton must only be run inside the quiz question loop.
sensei_simple_course_price sensei_simple_course_price function.
sensei_start_course_form sensei_start_course_form function.
sensei_the_course_results_lessons The the course result lessons template
sensei_the_excerpt Output the sensei excerpt
sensei_the_lesson_excerpt Returns the the lesson excerpt.
sensei_the_lesson_status_class Outputs the lesson status class
sensei_the_module_permalink Returns a permalink to the module currently loaded within the Single Course module loop.
sensei_the_module_status Print out the current module status
sensei_the_module_title

Ouputs the current module name. This must be used within the Sensei module loop.

sensei_the_module_title_attribute This function return the Module title to be used as an html element attribute value.
sensei_the_my_courses_content Outputs the content for the my courses page
sensei_the_question_class Outputs the question class. This must only be run withing the single quiz question loop.
sensei_the_question_content This function must only be run inside the quiz question loop.
sensei_the_single_lesson_meta Ouput the single lesson meta
sensei_user_login_url

Determine the login link on the frontend.

sensei_wc_add_to_cart sensei_wc_add_to_cart function.
Sensei Developer Reference API documentation generated by ApiGen