Browse: Home / Functions /

learndash_groupinfo_shortcode

learndash_groupinfo_shortcode( array $attr = array(),  string $content = '' )

Builds the [groupinfo] shortcode output.

Contents

Description #

Parameters #

$attr

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

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

Default value: array()

$content

(string) (Optional) The shortcode content.

Default value: ''

Return #

(string) shortcode output

Source #

File: includes/shortcodes/ld_groupinfo.php

Changelog #

Changelog
Version Description
3.2.0 Introduced.

Uses #

Uses
Uses Description
includes/ld-groups.php: learndash_get_user_group_status ()
includes/ld-groups.php: learndash_get_user_group_started_timestamp ()

Get the user started group timestamp.
includes/ld-groups.php: learndash_get_user_group_completed_timestamp ()

Get the user completed group timestamp.
includes/ld-groups.php: learndash_get_user_group_completed_percentage ()

Get the user completed group percentage.
includes/shortcodes/ld_groupinfo.php: learndash_groupinfo

Filter Group info shortcode value.
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_get_groups_user_ids ()

Gets the list of users ids that belong to a group.
includes/ld-groups.php: learndash_group_enrolled_courses ()

Gets the list of enrolled courses for a group.
includes/class-ldlms-post-types.php: learndash_get_post_type_slug ()

This function is documented in includes/class-ldlms-post-types.php