llms_get_page_id( string $page )

Retrieve the WordPress Page ID of a LifterLMS Core Page.

Contents

Description Description

Available core pages are:

  • checkout (formerly "shop")
  • courses (Course catalog)
  • myaccount (Student Dashboard)
  • memberships (Membership catalog)

Top ↑

Parameters Parameters

$page

(string) (Required) The page slug/name.

Top ↑

Return Return

(int) The WP_Post ID of the page or -1 if the page is not found.

Top ↑

Source Source

File: includes/functions/llms.functions.page.php 

function llms_get_page_id( $page ) {

	// Normalize some pages to make more sense without having to migrate options.
	if ( 'courses' === $page ) {
		$page = 'shop';
	}

	$id = get_option( 'lifterlms_' . $page . '_page_id' );

	/**
	 * Filter the ID of the requested LifterLMS Page.
	 *
	 * The dynamic portion of this filter, {$page}, refers to the LifterLMS page slug/name.
	 *
	 * Note that, historically, the course catalog was called the "shop" and therefore when requesting
	 * the filter will be "lifterlms_get_shop_page_id" instead of "lifterlms_get_courses_page_id".
	 *
	 * @since 1.0.0
	 *
	 * @param int|string $id The WP_Post ID of the requested page or an empty string if the page doesn't exist.
	 */
	$page = apply_filters( "lifterlms_get_{$page}_page_id", $id );

	return $page ? absint( $page ) : -1;

}

Expand full source code Collapse full source code View on GitHub

Top ↑

Top ↑

Used By Used By

Used By
Used By Description
includes/models/model.llms.user.certificate.php: LLMS_User_Certificate::get_merge_data()

Retrieve merge codes and data.
includes/functions/llms.functions.templates.certificates.php: llms_certificate_actions()

Loads the certificate actions template.
includes/class.llms.template.loader.php: LLMS_Template_Loader::get_maybe_forced_template()

Retrieve the hierarchical template to be loaded.
includes/functions/llms.functions.templates.loop.php: lifterlms_get_archive_description()

Retrieve the archive description for LifterLMS catalogs pages and post type / tax archives.
includes/theme-support/class-llms-twenty-twenty.php: LLMS_Twenty_Twenty::get_archive_page_id()

Retrieve the page ID of a a catalog page.
includes/abstracts/abstract.llms.payment.gateway.php: LLMS_Payment_Gateway::get_complete_transaction_redirect_url()

Calculates the url to redirect to on transaction completion.
includes/llms.template.functions.php: llms_person_my_courses_url()

Get the link to the My Courses endpoint
includes/llms.template.functions.php: llms_person_redeem_voucher_url()

Get the link to the redeem voucher page
includes/llms.template.functions.php: llms_person_edit_account_url()

Get the link to the edit account details page
includes/functions/llms-functions-conditional-tags.php: is_llms_account_page()

Determine if the LifterLMS Student Dashboard (account page) is being displayed.
includes/functions/llms-functions-conditional-tags.php: is_llms_checkout()

Determine if the LifterLMS Checkout page is being displayed.
includes/functions/llms-functions-conditional-tags.php: is_memberships()

Determine if the membership catalog (post type archive) is being displayed.
includes/functions/llms-functions-conditional-tags.php: is_courses()

Determine if the course catalog (post type archive) is being displayed.
includes/llms.template.functions.php: lifterlms_page_title()
includes/llms.template.functions.php: llms_template_redirect()

Template Redirect
includes/achievements/class.llms.achievement.user.php: LLMS_Achievement_User::init()

Initializes all of the variables needed to create the achievement post.
includes/class.llms.post-types.php: LLMS_Post_Types::register_post_types()

Register Post Types.
includes/class.llms.query.php: LLMS_Query::pre_get_posts()

Sets the WP_Query variables for “post_type” on LifterLMS custom taxonomy archive pages for Courses and Memberships.
includes/functions/llms.functions.templates.dashboard.php: lifterlms_student_dashboard()

Output the LifterLMS Student Dashboard
includes/functions/llms.functions.page.php: llms_confirm_payment_url()

Get url for redirect when user confirms payment.
includes/functions/llms.functions.page.php: llms_lostpassword_url()

Returns the url to the lost password endpoint url.
includes/functions/llms.functions.page.php: llms_get_page_url()

Retrieve the URL for a LifterLMS Page.
includes/functions/llms.functions.page.php: llms_cancel_payment_url()

Get url for when user cancels payment.
includes/functions/llms.functions.access.php: llms_is_post_restricted_by_sitewide_membership()

Determine if a post should bypass sitewide membership restrictions.
includes/forms/controllers/class.llms.controller.login.php: LLMS_Controller_Login::login()

Handle Login Form Submission
includes/class.llms.cache.helper.php: LLMS_Cache_Helper::maybe_no_cache()

Define nocache constants and set nocache headers on specified pages
includes/admin/post-types/post-tables/class.llms.admin.post.table.pages.php: LLMS_Admin_Post_Table_Pages::__construct()

Constructor
includes/emails/class.llms.email.engagement.php: LLMS_Email_Engagement::init()

Initialize all variables
includes/certificates/class.llms.certificate.user.php: LLMS_Certificate_User::init()

Sets up data needed to generate certificate.
includes/class.llms.nav.menus.php: LLMS_Nav_Menus::menu_item_classes()

Add “active” classes to menu items for LLMS catalog pages.
Show 25 more used by Hide more used by

Top ↑

Changelog Changelog

Changelog
Version Description
1.0.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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