Browse: Home / Functions /

learndash_previous_post_link

learndash_previous_post_link( string|null $default_value = '',  string|bool $url = false,  WP_Post|null $post = null )

Generates the previous post link/url/ID for a lesson/topic/quiz in a course.

Contents

Description #

Important note: learndash_clear_prev_next_links() affects it via learndash_previous_post_link hook. For some historical reason, it affects the link case only, not ID or URL.

Parameters #

$default_value

(string|null) (Optional) Default previous post link. Null type is added for backward compatibility.

Default value: ''

$url

(string|bool) (Optional) Whether to return URL or ID instead of HTML output. If true, the URL is returned. If 'id', ID is returned. Otherwise, an HTML link is returned.

Default value: false

$post

(WP_Post|null) (Optional) Current post. If not passed, the global post object is used.

Default value: null

Return #

(string|int) Previous post link URL or HTML link or Post ID depending on the $url parameter. If a link cannot be generated, the default value will be returned.

Source #

File: includes/course/ld-course-navigation.php

Changelog #

Changelog
Version Description
4.11.0 Added support for quizzes.
2.1.0 Introduced.

Uses #

Uses
Uses Description
includes/course/ld-course-navigation.php: learndash_course_previous_step_default_value

Filters previous step default value for the course.
includes/course/ld-course-navigation.php: learndash_course_previous_step_id

Filters previous step ID for the course.
includes/course/ld-course-navigation.php: learndash_course_previous_step_url

Filters previous step url for the course.
src/Core/Utilities/Cast.php: Cast::to_string ()

Casts a value to a string if possible or returns an empty string.
src/Core/Utilities/Cast.php: Cast::to_int ()

Casts a value to a int if possible or returns an empty string.
src/Core/Utilities/Cast.php: Cast::to_bool ()

Casts a value to a bool if possible or returns an empty string.
includes/class-ld-custom-label.php: learndash_get_label_course_step_previous ()

Get Course Step “Previous .
includes/class-ld-permalinks.php: learndash_get_step_permalink ()

Utility function to get the nested permalink of the course step within in the course.
includes/class-ldlms-post-types.php: LDLMS_Post_Types::get_post_type_slug ()

Utility function to return the post type slug(s). This is to prevent hard-coding of the slug(s) throughout the code files.
includes/course/ld-course-functions.php: learndash_get_course_id ()

Gets the course ID for a resource.
includes/course/ld-course-navigation.php: learndash_previous_post_link

Filters previous post link output for the course.