v2/Topics – LearnDash Dev Docs

Schema
List Topics
Create a Topic
- Arguments
- Definition
List Topics
Update a Topic
Delete a Topic

Schema #

The schema defines all the fields that exist within a topic record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.

`date` string, null, datetime (details)	The date the object was published, in the site's timezone. Context: `view`, `edit`, `embed`
`date_gmt` string, null, datetime (details)	The date the object was published, as GMT. Context: `view`, `edit`
`guid` object	The globally unique identifier for the object. Read only Context: `view`, `edit`
`id` integer	Unique identifier for the object. Read only Context: `view`, `edit`, `embed`
`link` string, uri	URL to the object. Read only Context: `view`, `edit`, `embed`
`modified` string, datetime (details)	The date the object was last modified, in the site's timezone. Read only Context: `view`, `edit`
`modified_gmt` string, datetime (details)	The date the object was last modified, as GMT. Read only Context: `view`, `edit`
`slug` string	An alphanumeric identifier for the object unique to its type. Context: `view`, `edit`, `embed`
`status` string	A named status for the object. Context: `view`, `edit` One of: `publish`, `future`, `draft`, `pending`, `private`, `graded`, `not_graded`
`type` string	Type of Post for the object. Read only Context: `view`, `edit`, `embed`
`password` string	A password to protect access to the content and excerpt. Context: `edit`
`permalink_template` string	Permalink template for the object. Read only Context: `edit`
`generated_slug` string	Slug automatically generated from the object title. Read only Context: `edit`
`title` object	The title for the object. Context: `view`, `edit`, `embed`
`content` object	The content for the object. Context: `view`, `edit`
`author` integer	The ID for the author of the object. Context: `view`, `edit`, `embed`
`featured_media` integer	The ID of the featured media for the object. Context: `view`, `edit`, `embed`
`comment_status` string	Whether or not comments are open on the object. Context: `view`, `edit` One of: `open`, `closed`
`ping_status` string	Whether or not the object can be pinged. Context: `view`, `edit` One of: `open`, `closed`
`menu_order` integer	The order of the object in relation to other object of its type. Context: `view`, `edit`
`template` string	The theme file to use to display the object. Context: `view`, `edit`
`categories` array	The terms assigned to the object in the category taxonomy. Context: `view`, `edit`
`tags` array	The terms assigned to the object in the post_tag taxonomy. Context: `view`, `edit`
`ld_topic_category` array	The terms assigned to the object in the ld_topic_category taxonomy. Context: `view`, `edit`
`ld_topic_tag` array	The terms assigned to the object in the ld_topic_tag taxonomy. Context: `view`, `edit`
`materials_enabled` boolean	Materials Eabled Context: `view`, `edit`
`materials` string	Materials Context: `view`, `edit`
`video_enabled` boolean	Topic Video Progression Eabled Context: `view`, `edit`
`video_url` text	Topic Video Progression URL Context: `view`, `edit`
`video_shown` string	Topic Video Shown before or after sub-steps Context: `view`, `edit` One of: `BEFORE`, `AFTER`
`video_auto_complete` boolean	Topic Video Auto-complete Context: `view`, `edit`
`video_auto_complete_delay` integer	Topic Video Completion Delay (seconds). Context: `view`, `edit`
`video_show_complete_button` boolean	Topic Video Show Mark Complete Button Context: `view`, `edit`
`video_auto_start` boolean	Topic Video Autostart Context: `view`, `edit`
`video_show_controls` boolean	Topic Video Controls Display. YouTube and local videos only Context: `view`, `edit`
`video_focus_pause` boolean	Video Pause on Window Unfocused Context: `view`, `edit`
`video_resume` boolean	Video Resume Context: `view`, `edit`
`assignment_upload_enabled` boolean	Topic Assignment Uploads Enabled Context: `view`, `edit`
`assignment_points_enabled` boolean	Topic Assignment Points Enabled Context: `view`, `edit`
`assignment_points_amount` integer	Topic Assignment Points Amount Context: `view`, `edit`
`assignment_auto_approve` boolean	Topic Assignment Auto-approve Enabled Context: `view`, `edit`
`assignment_deletion_enabled` boolean	Topic Assignment Allow File Deletion. Context: `view`, `edit`
`forced_timer_enabled` boolean	Topic Time Enabled Context: `view`, `edit`
`forced_timer_amount` integer	Topic Timer Amount. Context: `view`, `edit`
`course` integer	Associated Course Context: `view`, `edit`
`lesson` integer	Associated Lesson Context: `view`, `edit`
`assignment_upload_limit_extensions` text	Topic Assignment Allowed file extensions. Comma separated pdf, xls, zip Context: `view`, `edit`
`assignment_upload_limit_size` text	Topic Assignment Upload size limit. Max per server is 32M Context: `view`, `edit`
`assignment_upload_limit_count` integer	Topic Assignment Upload Count Limit. Context: `view`, `edit`

List Topics #

Query this endpoint to retrieve a collection of topics. The response you receive can be controlled and filtered using the URL query parameters below.

Definition #

GET /ldlms/v2/sfwd-topic

Example Request #

$ curl https://example.com/wp-json/ldlms/v2/sfwd-topic

Arguments #

`context`	Scope under which the request is made; determines fields present in response. Default: `view` One of: `view`, `embed`, `edit`
`page`	Current page of the collection. Default: `1`
`per_page`	Maximum number of items to be returned in result set. Default: `10`
`search`	Limit results to those matching a string.
`after`	Limit response to posts published after a given ISO8601 compliant date.
`modified_after`	Limit response to posts modified after a given ISO8601 compliant date.
`author`	Limit result set to posts assigned to specific authors.
`author_exclude`	Ensure result set excludes posts assigned to specific authors.
`before`	Limit response to posts published before a given ISO8601 compliant date.
`modified_before`	Limit response to posts modified before a given ISO8601 compliant date.
`exclude`	Ensure result set excludes specific IDs.
`include`	Limit result set to specific IDs.
`menu_order`	Limit result set to posts with a specific menu_order value.
`offset`	Offset the result set by a specific number of items.
`order`	Order sort attribute ascending or descending. Default: `asc` One of: `asc`, `desc`
`orderby`	Sort collection by object attribute. Default: `title` One of: `author`, `date`, `id`, `include`, `modified`, `parent`, `relevance`, `slug`, `include_slugs`, `title`, `menu_order`
`slug`	Limit result set to posts with one or more specific slugs.
`status`	Limit result set to posts assigned one or more statuses. Default: `publish`
`tax_relation`	Limit result set based on relationship between multiple taxonomies. One of: `AND`, `OR`
`categories`	Limit result set to items with specific terms assigned in the categories taxonomy.
`categories_exclude`	Limit result set to items except those with specific terms assigned in the categories taxonomy.
`tags`	Limit result set to items with specific terms assigned in the tags taxonomy.
`tags_exclude`	Limit result set to items except those with specific terms assigned in the tags taxonomy.
`ld_topic_category`	Limit result set to items with specific terms assigned in the ld_topic_category taxonomy.
`ld_topic_category_exclude`	Limit result set to items except those with specific terms assigned in the ld_topic_category taxonomy.
`ld_topic_tag`	Limit result set to items with specific terms assigned in the ld_topic_tag taxonomy.
`ld_topic_tag_exclude`	Limit result set to items except those with specific terms assigned in the ld_topic_tag taxonomy.
`course`	Limit results to be within a specific Course. Required for non-admin users.
`lesson`	Limit results to be within a specific Lesson. Must be used with Course parameter.

Create a Topic #

Arguments #

`date`	The date the object was published, in the site's timezone.
`date_gmt`	The date the object was published, as GMT.
`slug`	An alphanumeric identifier for the object unique to its type.
`status`	A named status for the object. One of: `publish`, `future`, `draft`, `pending`, `private`, `graded`, `not_graded`
`password`	A password to protect access to the content and excerpt.
`title`	The title for the object.
`content`	The content for the object.
`author`	The ID for the author of the object.
`featured_media`	The ID of the featured media for the object.
`comment_status`	Whether or not comments are open on the object. One of: `open`, `closed`
`ping_status`	Whether or not the object can be pinged. One of: `open`, `closed`
`menu_order`	The order of the object in relation to other object of its type.
`template`	The theme file to use to display the object.
`categories`	The terms assigned to the object in the category taxonomy.
`tags`	The terms assigned to the object in the post_tag taxonomy.
`ld_topic_category`	The terms assigned to the object in the ld_topic_category taxonomy.
`ld_topic_tag`	The terms assigned to the object in the ld_topic_tag taxonomy.
`materials_enabled`	Materials Eabled
`materials`	Materials
`video_enabled`	Topic Video Progression Eabled
`video_url`	Topic Video Progression URL
`video_shown`	Topic Video Shown before or after sub-steps Default: `ANY` One of: `BEFORE`, `AFTER`
`video_auto_complete`	Topic Video Auto-complete
`video_auto_complete_delay`	Topic Video Completion Delay (seconds).
`video_show_complete_button`	Topic Video Show Mark Complete Button
`video_auto_start`	Topic Video Autostart
`video_show_controls`	Topic Video Controls Display. YouTube and local videos only
`video_focus_pause`	Video Pause on Window Unfocused
`video_resume`	Video Resume
`assignment_upload_enabled`	Topic Assignment Uploads Enabled
`assignment_upload_limit_extensions`	Topic Assignment Allowed file extensions. Comma separated pdf, xls, zip
`assignment_upload_limit_size`	Topic Assignment Upload size limit. Max per server is 32M
`assignment_points_enabled`	Topic Assignment Points Enabled
`assignment_points_amount`	Topic Assignment Points Amount
`assignment_auto_approve`	Topic Assignment Auto-approve Enabled Default: `1`
`assignment_upload_limit_count`	Topic Assignment Upload Count Limit.
`assignment_deletion_enabled`	Topic Assignment Allow File Deletion.
`forced_timer_enabled`	Topic Time Enabled
`forced_timer_amount`	Topic Timer Amount.
`course`	Associated Course
`lesson`	Associated Lesson

Definition #

POST /ldlms/v2/sfwd-topic

List Topics #

Query this endpoint to retrieve a collection of topics. The response you receive can be controlled and filtered using the URL query parameters below.

Definition #

GET /ldlms/v2/sfwd-topic/<id>

Example Request #

$ curl https://example.com/wp-json/ldlms/v2/sfwd-topic/<id>

Arguments #

`context`	Scope under which the request is made; determines fields present in response. Default: `view` One of: `view`, `embed`, `edit`
`page`	Current page of the collection. Default: `1`
`per_page`	Maximum number of items to be returned in result set. Default: `10`
`search`	Limit results to those matching a string.
`after`	Limit response to posts published after a given ISO8601 compliant date.
`modified_after`	Limit response to posts modified after a given ISO8601 compliant date.
`author`	Limit result set to posts assigned to specific authors.
`author_exclude`	Ensure result set excludes posts assigned to specific authors.
`before`	Limit response to posts published before a given ISO8601 compliant date.
`modified_before`	Limit response to posts modified before a given ISO8601 compliant date.
`exclude`	Ensure result set excludes specific IDs.
`include`	Limit result set to specific IDs.
`menu_order`	Limit result set to posts with a specific menu_order value.
`offset`	Offset the result set by a specific number of items.
`order`	Order sort attribute ascending or descending. Default: `asc` One of: `asc`, `desc`
`orderby`	Sort collection by object attribute. Default: `title` One of: `author`, `date`, `id`, `include`, `modified`, `parent`, `relevance`, `slug`, `include_slugs`, `title`, `menu_order`
`slug`	Limit result set to posts with one or more specific slugs.
`status`	Limit result set to posts assigned one or more statuses. Default: `publish`
`tax_relation`	Limit result set based on relationship between multiple taxonomies. One of: `AND`, `OR`
`categories`	Limit result set to items with specific terms assigned in the categories taxonomy.
`categories_exclude`	Limit result set to items except those with specific terms assigned in the categories taxonomy.
`tags`	Limit result set to items with specific terms assigned in the tags taxonomy.
`tags_exclude`	Limit result set to items except those with specific terms assigned in the tags taxonomy.
`ld_topic_category`	Limit result set to items with specific terms assigned in the ld_topic_category taxonomy.
`ld_topic_category_exclude`	Limit result set to items except those with specific terms assigned in the ld_topic_category taxonomy.
`ld_topic_tag`	Limit result set to items with specific terms assigned in the ld_topic_tag taxonomy.
`ld_topic_tag_exclude`	Limit result set to items except those with specific terms assigned in the ld_topic_tag taxonomy.
`course`	Limit results to be within a specific Course. Required for non-admin users.
`lesson`	Limit results to be within a specific Lesson. Must be used with Course parameter.

Update a Topic #

Arguments #

`date`	The date the object was published, in the site's timezone.
`date_gmt`	The date the object was published, as GMT.
`slug`	An alphanumeric identifier for the object unique to its type.
`status`	A named status for the object. One of: `publish`, `future`, `draft`, `pending`, `private`, `graded`, `not_graded`
`password`	A password to protect access to the content and excerpt.
`title`	The title for the object.
`content`	The content for the object.
`author`	The ID for the author of the object.
`featured_media`	The ID of the featured media for the object.
`comment_status`	Whether or not comments are open on the object. One of: `open`, `closed`
`ping_status`	Whether or not the object can be pinged. One of: `open`, `closed`
`menu_order`	The order of the object in relation to other object of its type.
`template`	The theme file to use to display the object.
`categories`	The terms assigned to the object in the category taxonomy.
`tags`	The terms assigned to the object in the post_tag taxonomy.
`ld_topic_category`	The terms assigned to the object in the ld_topic_category taxonomy.
`ld_topic_tag`	The terms assigned to the object in the ld_topic_tag taxonomy.
`materials_enabled`	Materials Eabled
`materials`	Materials
`video_enabled`	Topic Video Progression Eabled
`video_url`	Topic Video Progression URL
`video_shown`	Topic Video Shown before or after sub-steps One of: `BEFORE`, `AFTER`
`video_auto_complete`	Topic Video Auto-complete
`video_auto_complete_delay`	Topic Video Completion Delay (seconds).
`video_show_complete_button`	Topic Video Show Mark Complete Button
`video_auto_start`	Topic Video Autostart
`video_show_controls`	Topic Video Controls Display. YouTube and local videos only
`video_focus_pause`	Video Pause on Window Unfocused
`video_resume`	Video Resume
`assignment_upload_enabled`	Topic Assignment Uploads Enabled
`assignment_upload_limit_extensions`	Topic Assignment Allowed file extensions. Comma separated pdf, xls, zip
`assignment_upload_limit_size`	Topic Assignment Upload size limit. Max per server is 32M
`assignment_points_enabled`	Topic Assignment Points Enabled
`assignment_points_amount`	Topic Assignment Points Amount
`assignment_auto_approve`	Topic Assignment Auto-approve Enabled
`assignment_upload_limit_count`	Topic Assignment Upload Count Limit.
`assignment_deletion_enabled`	Topic Assignment Allow File Deletion.
`forced_timer_enabled`	Topic Time Enabled
`forced_timer_amount`	Topic Timer Amount.
`course`	Associated Course
`lesson`	Associated Lesson

Definition #

POST /ldlms/v2/sfwd-topic/<id>

Example Request #

Delete a Topic #

Arguments #

force

Whether to bypass trash and force deletion.

Definition #

DELETE /ldlms/v2/sfwd-topic/<id>

Example Request #

$ curl -X DELETE https://example.com/wp-json/ldlms/v2/sfwd-topic/<id>

Topics

Contents

Schema #

List Topics #

Definition #

Example Request #

Arguments #

Create a Topic #

Arguments #

Definition #

List Topics #

Definition #

Example Request #

Arguments #

Update a Topic #

Arguments #

Definition #

Example Request #

Delete a Topic #

Arguments #

Definition #

Example Request #

The Most Trusted Online Course Platform for WordPress.