llms()

Returns the main instance of LifterLMS

Contents

Return Return

(LifterLMS)

Top ↑

Source Source

File: lifterlms.php 

function llms() {
	return LifterLMS::instance();
}

Expand full source code Collapse full source code View on GitHub

Top ↑

Used By Used By

Used By
Used By Description
includes/functions/llms.functions.order.php: llms_can_gateway_be_used_for_plan_or_order()

Determines if a payment gateway can be used to process transactions for an LLMS_Order or an LLMS_Access_Plan.
includes/class-llms-order-generator.php: LLMS_Order_Generator::validate_gateway()

Validates the payment gateway.
includes/class.llms.playnice.php: LLMS_PlayNice::buddyboss_compatibility()

Compatibility for BuddyBoss.
includes/integrations/class.llms.integration.buddypress.php: LLMS_Integration_Buddypress::enqueue_assets()

Enqueue assets specific for the profile endpoints.
includes/class-llms-engagement-handler.php: LLMS_Engagement_Handler::handle_email()

Send an email engagement
includes/class-llms-engagement-handler.php: LLMS_Engagement_Handler::get_image_id()

Retrieve the attachment id to use for the earned engagement thumbnail.
includes/class-llms-engagement-handler.php: LLMS_Engagement_Handler::create()

Create a new earned achievement or certificate.
includes/models/model.llms.user.certificate.php: LLMS_User_Certificate::get_background_image()

Retrieve information about the certificate background image.
includes/controllers/class-llms-controller-awards.php: LLMS_Controller_Awards::on_rest_insert()

Awarded certificate REST API insertion callback.
includes/admin/settings/class.llms.settings.engagements.php: LLMS_Settings_Engagements::get_settings_group_achievements()

Retrieve fields for the achievements settings group.
includes/admin/post-types/class.llms.meta.boxes.php: LLMS_Admin_Meta_Boxes::maybe_modify_post_thumbnail_html()

Modifies the featured image metabox for achievement and certificate templates.
includes/admin/class.llms.admin.assets.php: LLMS_Admin_Assets::admin_print_footer_scripts()

Output inline scripts in the admin footer.
includes/admin/class.llms.admin.assets.php: LLMS_Admin_Assets::admin_print_styles()

Output inline styles in the header.
includes/admin/class.llms.admin.assets.php: LLMS_Admin_Assets::block_editor_assets_for_certificates()

Enqueue block editor assets for certificate post types.
includes/forms/class-llms-form-field.php: LLMS_Form_Field::enqueue_strength_meter()

Enqueue password strength meter script.
includes/functions/llms.functions.template.php: llms_template_file_path()

Build the plugin’s template file path.
includes/class.llms.template.loader.php: LLMS_Template_Loader::block_template_loader()

Filter blocks templates.
includes/class.llms.frontend.assets.php: LLMS_Frontend_Assets::enqueue_content_protection()

Enqueue inline copy prevention scripts.
includes/notifications/views/class.llms.notification.view.upcoming.payment.reminder.php: LLMS_Notification_View_Upcoming_Payment_Reminder::set_body_email()

Setup default notification body for email notifications.
includes/class.llms.frontend.assets.php: LLMS_Frontend_Assets::enqueue_locale_scripts()

Enqueue dependencies and inline script data for form localization
includes/class.llms.view.manager.php: LLMS_View_Manager::get_menu_items_to_add()

Retrieve an array of nodes to be added to the admin bar
includes/admin/class-llms-admin-profile.php: LLMS_Admin_Profile::add_user_meta_fields()

Add user meta fields to the profile screens
libraries/lifterlms-helper/class-lifterlms-helper.php: LifterLMS_Helper::init()

Inititalize the Plugin
includes/admin/class.llms.admin.import.php: LLMS_Admin_Import::enqueue()

Enqueue static assets used on the screen
includes/class.llms.frontend.assets.php: LLMS_Frontend_Assets::enqueue_inline_scripts()

Enqueue inline scripts.
includes/admin/class.llms.admin.assets.php: LLMS_Admin_Assets::maybe_enqueue_reporting()

Register and enqueue scripts used on and related-to reporting and analytics
includes/class.llms.ajax.handler.php: LLMS_AJAX_Handler::persist_tracking_events()

AJAX handler for persisting tracking events.
includes/admin/settings/class.llms.settings.engagements.php: LLMS_Settings_Engagements::get_settings_group_certs()

Retrieve fields for the certificates settings group.
includes/class-llms-events-core.php: LLMS_Events_Core::on_signon()

Record account.signon event via wp_login hook.
includes/class-llms-events-core.php: LLMS_Events_Core::on_signout()

Record an account.signout event via wp_logout()
includes/class-llms-sessions.php: LLMS_Sessions::start()

Start a new session for the current user.
includes/class-llms-sessions.php: LLMS_Sessions::end()

End a session.
libraries/lifterlms-rest/includes/abstracts/class-llms-rest-webhook-data.php: LLMS_REST_Webhook_Data::get_user_agent()

Retrieve a user agent string to use for delivering webhooks.
libraries/lifterlms-rest/class-lifterlms-rest-api.php: LifterLMS_REST_API::init()

Include all required files and classes.
includes/llms.template.functions.php: llms_placeholder_img_src()

Get the placeholder image URL for courses
includes/class.llms.frontend.assets.php: LLMS_Frontend_Assets::output_footer_scripts()

Output inline scripts in the footer
includes/class.llms.frontend.assets.php: LLMS_Frontend_Assets::output_header_scripts()

Output inline scripts in the header
includes/class.llms.frontend.assets.php: LLMS_Frontend_Assets::enqueue_styles()

Enqueue Styles
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.transaction.php: LLMS_Transaction::get_gateway()

Retrieves 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.
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.
includes/llms.functions.core.php: llms_get_donut()

Retrieve the HTML for a donut 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/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
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.
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()

Template for My Notifications student dashboard endpoint
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.page.php: llms_get_endpoint_url()

Retrieve the full URL to a LifterLMS endpoint.
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()

Download a Certificate.
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::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
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/shortcodes/class.llms.shortcode.registration.php: LLMS_Shortcode_Registration::get_output()

Retrieve the actual content of the shortcode
includes/class.llms.view.manager.php: LLMS_View_Manager::scripts()

Enqueue Scripts.
includes/class.llms.install.php: LLMS_Install::install()

Core install function
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/integrations/class.llms.integration.bbpress.php: LLMS_Integration_BBPress::configure()

Configure the integration
includes/admin/class.llms.admin.setup.wizard.php: LLMS_Admin_Setup_Wizard::enqueue()

Enqueue static assets for the setup wizard screens
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.order.details.php: LLMS_Meta_Box_Order_Details::output()

Output metabox content
includes/admin/class.llms.admin.import.php: LLMS_Admin_Import::upload_import()

Handle form submission
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
includes/notifications/processors/class.llms.notification.processor.email.php: LLMS_Notification_Processor_Email::task()

Processes an item in the queue
includes/notifications/class.llms.notifications.php: LLMS_Notifications::enqueue_basic()

Enqueue basic notifications for onscreen display
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.
libraries/lifterlms-blocks/includes/class-llms-blocks.php: LLMS_Blocks::init()

Register all blocks & components.
Show 109 more used by Hide more used by

Top ↑

Changelog Changelog

Changelog
Version Description
4.0.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.