LLMS()
Returns the main instance of LLMS
Description #Description
Return #Return
(LifterLMS)
Source #Source
File: lifterlms.php
function LLMS() { return LifterLMS::instance(); }
Expand full source code Collapse full source code View on GitHub
Related #Related
Uses #Uses
Uses | Description |
---|---|
lifterlms.php: LifterLMS::instance() |
Main Instance of LifterLMS Ensures only one instance of LifterLMS is loaded or can be loaded. |
Used By #Used By
Used By | Description |
---|---|
includes/llms.template.functions.php: llms_get_product() |
Get Product |
includes/llms.template.functions.php: llms_get_quiz() |
Get Quiz |
includes/llms.template.functions.php: llms_get_question() |
Get Question |
includes/llms.template.functions.php: llms_placeholder_img_src() |
Get the placeholder image URL for courses |
includes/class.llms.person.php: LLMS_Person::get_user_achievements() |
Get user postmeta achievements |
includes/class.llms.person.php: LLMS_Person::__construct() |
Constructor |
includes/class.llms.frontend.assets.php: LLMS_Frontend_Assets::enqueue_scripts() |
Enqueue Scripts |
includes/models/model.llms.user.achievement.php: LLMS_User_Achievement::get_image() |
Retrieve the image source for the achievement |
includes/models/model.llms.order.php: LLMS_Order::get_gateway() |
Retrieve the payment gateway instance for the order’s selected payment gateway |
includes/models/model.llms.student.php: LLMS_Student::get_grade() |
Get the students grade for a lesson / course All grades are based on quizzes assigned to lessons |
includes/models/model.llms.notification.php: LLMS_Notification::get_view() |
Retrieve an instance of the notification view class for the notification |
includes/models/model.llms.transaction.php: LLMS_Transaction::get_gateway() |
Retrieve the payment gateway instance for the transactions payment gateway |
includes/models/model.llms.quiz.attempt.php: LLMS_Quiz_Attempt::calculate_grade() |
Calculate and the grade for a completed quiz |
includes/models/model.llms.product.php: LLMS_Product::is_purchasable() |
Determine if the product is purchasable At least one gateway must be enabled and at least one access plan must exist If the product is a course, additionally checks to ensure course enrollment is open and has capacity |
includes/processors/class.llms.processor.membership.bulk.enroll.php: LLMS_Processor_Membership_Bulk_Enroll::task() |
Execute calculation for each item in the queue until all students in the course have been polled Stores the data in the postmeta table to be accessible via LLMS_Course |
includes/processors/class.llms.processor.table.to.csv.php: LLMS_Processor_Table_To_Csv::task() |
Execute calculation for each item in the queue until all students in the course have been polled Stores the data in the postmeta table to be accessible via LLMS_Course |
includes/llms.functions.core.php: llms_get_donut() |
Retrieve the HTML for a donut chart Note that this must be used in conjunction with some JS to initialize the chart! |
includes/abstracts/llms.abstract.notification.view.php: LLMS_Abstract_Notification_View::set_merge_data_default() |
Replace default merge codes with actual values |
includes/abstracts/llms.abstract.notification.view.php: LLMS_Abstract_Notification_View::get_icon_default() |
Retrieve a default icon for the notification based on the notification type |
includes/abstracts/abstract.llms.post.model.php: LLMS_Post_Model::export() |
Trigger an export download of the given post type |
includes/abstracts/llms.abstract.exportable.admin.table.php: LLMS_Abstract_Exportable_Admin_Table::is_export_locked() |
Determine if the table is currently locked due to export generation. |
includes/abstracts/abstract.llms.payment.gateway.php: LLMS_Payment_Gateway::is_default_gateway() |
Determine if the gateway is the default gateway This will be the FIRST gateway in the gateways that are enabled |
includes/abstracts/llms.abstract.notification.controller.php: LLMS_Abstract_Notification_Controller::send_one() |
Send a notification for a subscriber |
includes/abstracts/llms.abstract.notification.controller.php: LLMS_Abstract_Notification_Controller::get_mock_view() |
Get a fake instance of a view, used for managing options & customization on the admin panel |
includes/abstracts/llms.abstract.notification.view.quiz.completion.php: LLMS_Abstract_Notification_View_Quiz_Completion::set_body_email() |
Setup body for email notification |
includes/privacy/class-llms-privacy-exporters.php: LLMS_Privacy_Exporters::get_certificate_data() |
Get data for a certificate |
includes/privacy/class-llms-privacy-exporters.php: LLMS_Privacy_Exporters::maybe_add_export_files() |
Add files to the zip file for a data export request Adds certificate files into the /certificates/ directory within the archive |
includes/functions/llms.functions.notice.php: llms_add_notice() |
Stores notice in llms_notices session |
includes/functions/llms.functions.notice.php: llms_clear_notices() |
Clears all notices from session |
includes/functions/llms.functions.notice.php: llms_get_notices() |
Gets messages and errors which are stored in the session, then clears them. |
includes/functions/llms.functions.notice.php: llms_notice_count() |
Returns a count of all current notices by type. |
includes/functions/llms.functions.templates.dashboard.php: lifterlms_template_student_dashboard_my_notifications() | |
includes/functions/llms.functions.templates.dashboard.php: lifterlms_template_student_dashboard_my_grades() | |
includes/functions/llms.functions.template.php: llms_get_template_part() |
Get template part |
includes/functions/llms.functions.template.php: llms_get_template_part_contents() |
Get Template part contents |
includes/functions/llms.functions.template.php: llms_locate_template() |
Locate Template |
includes/functions/llms.functions.course.php: get_course() |
Get page object |
includes/functions/llms.functions.course.php: get_lesson() |
get lesson object |
includes/functions/llms.functions.certificate.php: llms_get_certificate_image() |
Retrieve an array of image data for a certificate background image |
includes/functions/llms.functions.certificate.php: llms_get_certificate_content() |
Retrieve the content of a certificate |
includes/functions/llms.functions.page.php: llms_get_endpoint_url() |
Retrieve the full URL to a LifterLMS endpoint |
includes/functions/llms.functions.order.php: llms_can_gateway_be_used_for_plan() |
Determine if a gateway can be used for a give LLMS_Access_Plan. |
includes/functions/llms.functions.order.php: llms_setup_pending_order() |
Setup a pending order which can be passed to an LLMS_Payment_Gateway for processing. |
includes/class.llms.ajax.handler.php: LLMS_AJAX_Handler::remove_coupon_code() |
Remove a coupon from an order during checkout |
includes/class.llms.ajax.handler.php: LLMS_AJAX_Handler::validate_coupon_code() |
Validate a Coupon via the Checkout Form |
includes/controllers/class.llms.controller.certificates.php: LLMS_Controller_Certificates::download() |
Generates an HTML export of the certificate from the “Download” button on the View Certificate front end & on reporting backend for admins |
includes/controllers/class.llms.controller.orders.php: LLMS_Controller_Orders::validate_selected_gateway() |
Validate a gateway can be used to process the current action / transaction |
includes/controllers/class.llms.controller.orders.php: LLMS_Controller_Orders::confirm_pending_order() |
Confirm order form post User clicks confirm order or gateway determines the order is confirmed |
includes/controllers/class.llms.controller.orders.php: LLMS_Controller_Orders::complete_order() |
Perform actions on a successful order completion |
includes/forms/controllers/class.llms.controller.account.php: LLMS_Controller_Account::lost_password() |
Handle form submission of the Lost Password form This is the form that sends a password recovery email with a link to reset the password |
includes/forms/frontend/class.llms.frontend.password.php: LLMS_Frontend_Password::retrieve_password() |
Lost password template |
includes/shortcodes/class.llms.shortcode.checkout.php: LLMS_Shortcode_Checkout::output() |
Gather a bunch of information and output the actual content for the shortcode |
includes/class.llms.view.manager.php: LLMS_View_Manager::add_menu_items() |
Add view links to the admin menu bar for qualifying users |
includes/class.llms.engagements.php: LLMS_Engagements::handle_achievement() |
Award an achievement |
includes/class.llms.engagements.php: LLMS_Engagements::handle_certificate() |
Award a certificate |
includes/class.llms.engagements.php: LLMS_Engagements::handle_email() |
Send an email engagement |
includes/class.llms.install.php: LLMS_Install::install() |
Core install function |
includes/class.llms.install.php: LLMS_Install::update_notice() |
Stores an admin notice for the current state of the background updater |
includes/class.llms.install.php: LLMS_Install::update_db_version() |
Update the LifterLMS DB record to the latest version |
includes/class.llms.install.php: LLMS_Install::update_llms_version() |
Update the LifterLMS version record to the latest version |
includes/class.llms.install.php: LLMS_Install::check_version() |
Checks the current LLMS version and runs installer if required |
includes/class.llms.template.loader.php: LLMS_Template_Loader::template_loader() |
Check if content should be restricted and include overrides where appropriate triggers various actions based on content restrictions |
includes/integrations/class.llms.integration.bbpress.php: LLMS_Integration_BBPress::configure() |
Configure the integration |
includes/admin/llms.functions.admin.php: llms_merge_code_button() |
Add a “merge code” button that to auto-add merge codes to email & etc. |
includes/admin/class.llms.admin.setup.wizard.php: LLMS_Admin_Setup_Wizard::output() |
Output the HTML content of the setup page |
includes/admin/class.llms.admin.setup.wizard.php: LLMS_Admin_Setup_Wizard::enqueue() |
Enqueue static assets for the setup wizard screens |
includes/admin/class.llms.admin.settings.php: LLMS_Admin_Settings::set_field_descriptions() |
Setup a field’s tooltip and description based on supplied values |
includes/admin/class.llms.admin.analytics.php: LLMS_Admin_Analytics::save_search_fields() |
Save admin fields. |
includes/admin/settings/class.llms.settings.checkout.php: LLMS_Settings_Checkout::get_settings_gateway() |
Retrieve settings for a gateway section |
includes/admin/settings/class.llms.settings.checkout.php: LLMS_Settings_Checkout::save() |
Override default save method to save the display order of payment gateways |
includes/admin/settings/class.llms.settings.notifications.php: LLMS_Settings_Notifications::after_save() |
Send a test notification after notification data is saved |
includes/admin/settings/class.llms.settings.checkout.php: LLMS_Settings_Checkout::get_gateway_table_html() |
Get HTML for the payment gateways table |
includes/admin/settings/class.llms.settings.checkout.php: LLMS_Settings_Checkout::get_sections() |
Get the page sections |
includes/admin/settings/class.llms.settings.notifications.php: LLMS_Settings_Notifications::get_settings() |
Get settings array |
includes/admin/settings/tables/class.llms.table.notification.settings.php: LLMS_Table_NotificationSettings::get_results() |
Execute a query to retrieve results from the table |
includes/admin/settings/class.llms.settings.general.php: LLMS_Settings_General::get_settings() |
Get settings array |
includes/admin/settings/class.llms.settings.integrations.php: LLMS_Settings_Integrations::get_sections() |
Get the page sections |
includes/admin/settings/class.llms.settings.integrations.php: LLMS_Settings_Integrations::get_table_html() |
Get HTML for the integrations table |
includes/admin/post-types/post-tables/class.llms.admin.post.table.courses.php: LLMS_Admin_Post_Table_Courses::handle_bulk_actions() |
Exports courses from the Bulk Actions menu on the courses post table |
includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.image.php: LLMS_Metabox_Image_Field::output() |
outputs the Html for the given field |
includes/admin/post-types/meta-boxes/class.llms.meta.box.expiration.php: LLMS_Meta_Box_Expiration::output() |
Static output class. |
includes/admin/analytics/class.llms.analytics.memberships.php: LLMS_Analytics_Memberships::get_analytics() |
Main Analytics page builder Collects elements and calls get_page_contents to wrap html Called from html.admin.analytics to build page. |
includes/admin/analytics/class.llms.analytics.memberships.php: LLMS_Analytics_Memberships::search_form() |
Builds Search Form |
includes/admin/analytics/class.llms.analytics.courses.php: LLMS_Analytics_Courses::get_analytics() |
Main Analytics page builder Collects elements and calls get_page_contents to wrap html Called from html.admin.analytics to build page. |
includes/admin/analytics/class.llms.analytics.courses.php: LLMS_Analytics_Courses::search_form() |
Builds Search Form |
includes/admin/class.llms.admin.import.php: LLMS_Admin_Import::upload_import() |
Handle form submission |
includes/admin/analytics/class.llms.analytics.sales.php: LLMS_Analytics_Sales::get_analytics() |
Main Analytics page builder Collects elements and calls get_page_contents to wrap html Called from html.admin.analytics to build page. |
includes/admin/analytics/class.llms.analytics.sales.php: LLMS_Analytics_Sales::search_form() |
Builds Search Form |
includes/admin/class.llms.admin.assets.php: LLMS_Admin_Assets::register_quill() |
Register Quill CSS & JS |
includes/admin/class.llms.admin.assets.php: LLMS_Admin_Assets::admin_styles() |
Enqueue stylesheets |
includes/admin/class.llms.admin.assets.php: LLMS_Admin_Assets::admin_scripts() |
Enqueue scripts |
includes/admin/class.llms.admin.notices.core.php: LLMS_Admin_Notices_Core::gateways() |
Check for gateways and output gateway notice |
includes/emails/class.llms.email.php: LLMS_Email::__construct() |
Constructor Sets up data needed to generate email content |
includes/class.llms.data.php: LLMS_Data::get_integrations_data() |
Get data about existing llms integrations |
includes/class.llms.data.php: LLMS_Data::get_llms_settings() |
Get LifterLMS settings |
includes/class.llms.data.php: LLMS_Data::get_templates_data() |
Retrieve information about template overrides |
includes/class.llms.data.php: LLMS_Data::get_gateway_data() |
Get data about llms payment gateways |
includes/class.llms.emails.php: LLMS_Emails::__construct() |
Constructor Initializes class Adds actions to trigger emails off of events |
includes/class.llms.quiz.legacy.php: LLMS_Quiz_Legacy::previous_question() |
Previous question button click Finds the previous question and redirects the user to the post |
includes/class.llms.quiz.legacy.php: LLMS_Quiz_Legacy::get_course() |
Retrieve the course associated with the lesson |
includes/notifications/processors/class.llms.notification.processor.email.php: LLMS_Notification_Processor_Email::task() |
Processes an item in the queue |
includes/notifications/views/class.llms.notification.view.quiz.graded.php: LLMS_Notification_View_Quiz_Graded::set_merge_data() |
Replace merge codes with actual values |
includes/notifications/views/class.llms.notification.view.quiz.graded.php: LLMS_Notification_View_Quiz_Graded::set_body_email() |
Setup body for email notification |
includes/notifications/views/class.llms.notification.view.purchase.receipt.php: LLMS_Notification_View_Purchase_Receipt::set_body() |
Setup body content for output |
includes/notifications/views/class.llms.notification.view.achievement.earned.php: LLMS_Notification_View_Achievement_Earned::set_merge_data() |
Replace merge codes with actual values |
includes/notifications/views/class.llms.notification.view.payment.retry.php: LLMS_Notification_View_Payment_Retry::set_body_email() |
Setup default notification body for email notifications |
includes/notifications/views/class.llms.notification.view.manual.payment.due.php: LLMS_Notification_View_Manual_Payment_Due::set_body_email() |
Setup default notification body for email notifications |
User Contributed Notes #User Contributed Notes
Permalink: