learndash_courseinfo

learndash_courseinfo( array $attr )

Builds the courseinfo shortcode output.

Contents

Description #

Shortcode that displays the requested course information.

Parameters #

$attr

(array) (Required) An array of shortcode attributes.

  • 'show'
    (string) Optional. The course info field to display. Default 'course_title'.
  • 'user_id'
    (int|string) Optional. User ID. Default empty.
  • 'course_id'
    (int|string) Optional. Course ID. Default empty.
  • 'format'
    (int|string) Optional. Date display format. Default 'F j, Y, g:i a'.
  • 'seconds_format'
    (int|string) Optional. Seconds format. Default 'time'.
  • 'decimals'
    (int) Optional. The number of decimal points. Default 2.

Return #

(string) The courseinfo shortcode output.

Source #

File: includes/shortcodes/ld_courseinfo.php

Changelog #

Changelog
Version Description
2.1.0 Introduced.

Uses #

Uses
Uses Description
includes/ld-misc-functions.php: learndash_seconds_to_time ()

Converts the seconds to time output.
includes/ld-misc-functions.php: learndash_adjust_date_time_display ()

Converts a timestamp to local timezone adjusted display.
includes/ld-misc-functions.php: learndash_get_setting ()

Gets the LearnDash setting for a post.
includes/ld-groups.php: learndash_is_admin_user ()

Checks if a user has the admin capabilities.
includes/ld-groups.php: learndash_is_group_leader_user ()

Checks if a user has the group leader capabilities.
includes/ld-groups.php: learndash_user_group_enrolled_to_course_from ()

Gets timestamp of when the course is available to a user in a group.
includes/ld-users.php: learndash_get_user_course_points ()

Gets the course points for a user.
includes/ld-reports.php: learndash_reports_get_activity ()

Queries the user activity for the report.
includes/class-ldlms-post-types.php: learndash_get_post_type_slug ()

This function is documented in includes/class-ldlms-post-types.php
includes/shortcodes/ld_courseinfo.php: learndash_courseinfo

Filters courseinfo shortcode output.
includes/shortcodes/ld_courseinfo.php: learndash_courseinfo_quizzes

Filters Quizzes to be included in calculations.
includes/course/ld-course-steps-functions.php: learndash_course_get_steps_by_type ()

Gets the course steps by type.
includes/course/ld-course-functions.php: learndash_user_get_course_completed_date ()

Gets the course completion date for a user.
includes/course/ld-course-user-functions.php: learndash_get_users_for_course ()

Gets the list of users who has access to the given course.
includes/course/ld-course-functions.php: learndash_get_course_points ()

Gets the course points for a given course ID.
includes/course/ld-course-functions.php: learndash_get_course_id ()

Gets the course ID for a resource.