### Method: LearnDash_Setup_Wizard::install()

Source: https://developers.learndash.com/files/includes_class-ld-setup-wizard-php

Installs a plugin as part of the setup wizard process.

```APIDOC
## Method: LearnDash_Setup_Wizard::install()

### Description
Install a plugin

### @since
4.0.0

### @package
LearnDash

### Source Files
includes/class-ld-setup-wizard.php
```

--------------------------------

### LearnDash_Setup_Wizard Class Overview

Source: https://developers.learndash.com/class/learndash_setup_wizard

Overview of the LearnDash Setup Wizard class, responsible for guiding users through the initial setup process.

```APIDOC
## Class: LearnDash_Setup_Wizard

### Description

Setup wizard class for LearnDash.

### Namespace

global

### @package

LearnDash
```

--------------------------------

### Example usage for learndash-all-infobar-before

Source: https://developers.learndash.com/hook/learndash-all-infobar-before

Implementation example for the action hook.

```php
<?php
/**
 * Example usage for learndash-all-infobar-before action.
 */
add_action(
    'learndash-all-infobar-before',
    function( $post_type, $user_id ) {
        // May add any custom logic using $post_type, $user_id
    },
    10,
    2
);
```

--------------------------------

### Example Usage

Source: https://developers.learndash.com/hook/learndash-focus-content-footer-after

Implementation example for the learndash-focus-content-footer-after action.

```php
<?php
/**
 * Example usage for learndash-focus-content-footer-after action.
 */
add_action(
    'learndash-focus-content-footer-after',
    function( $course_id, $user_id ) {
        // May add any custom logic using $course_id, $user_id
    },
    10,
    2
);
```

--------------------------------

### Example Usage

Source: https://developers.learndash.com/hook/learndash-topic-list-progress-before

Implementation example for the hook.

```php
<?php
/**
 * Example usage for learndash-topic-list-progress-before action.
 */
add_action(
    'learndash-topic-list-progress-before',
    function( $lesson_id, $course_id, $user_id ) {
        // May add any custom logic using $lesson_id, $course_id, $user_id
    },
    10,
    3
);
```

--------------------------------

### Example Usage

Source: https://developers.learndash.com/hook/learndash-focus-header-logo-before

Implementation example for the learndash-focus-header-logo-before action.

```php
<?php
/**
 * Example usage for learndash-focus-header-logo-before action.
 */
add_action(
    'learndash-focus-header-logo-before',
    function( $course_id, $user_id ) {
        // May add any custom logic using $course_id, $user_id
    },
    10,
    2
);
```

--------------------------------

### LearnDash Setup Wizard Methods

Source: https://developers.learndash.com/class/learndash_setup_wizard

Details of the methods available within the LearnDash Setup Wizard class.

```APIDOC
## Methods

### `__construct`

The single instance of the class.

### `create_courses_listing_page`

Create courses listing page.

### `create_profile_page`

Create profile page during Setup Wizard completion.

### `create_registration_pages`

Create registration, registration success, reset password and profile pages.

### `dismiss`

Dismiss the setup wizard.

### `enable_stripe_connect_and_redirect`

Enables the Stripe connect and then redirects to the wizard again.

### `enqueue_scripts`

Register the script for the setup wizard.

### `finalize_setup`

Ajax endpoint for finalizing the setup.

### `get_completed_redirect_url`

Returns the redirect URL after the wizard is completed.

### `get_scenes`

Get the list of scenes available in the setup wizard.

### `install`

Install a plugin required for LearnDash.

### `maybe_install_a_plugin`

Conditionally installs a plugin.

### `redirect_after_activation`

Redirect to the setup wizard after an activation.

### `register_menu`

Register the admin page for the setup wizard in the admin menu.

### `render`

Output the HTML root for the React app used in the setup wizard.

### `sanitize_text_fields`

Sanitize an array of text fields recursively.

### `save_data`

An ajax endpoint for saving wizard data. When the user moves to the next step, the current state is stored in the database.

### `set_redirect_flag`

Check when the wizard needs to be shown and set an option for that.

### `should_display`

Determines if the wizard should be displayed. If there is no license key stored in the database, then the wizard should be shown.

### `update_data`

Update the wizard data.

### `verify_license`

Ajax endpoint to trigger a request to validate the license key.

### `wp_shutdown`

Check when the wizard needs to be shown and set an option for that during the WordPress shutdown process.
```

--------------------------------

### Example Usage

Source: https://developers.learndash.com/hook/ld_added_course_group_access

Implementation example for the ld_added_course_group_access action.

```php
<?php
/**
 * Example usage for ld_added_course_group_access action.
 */
add_action(
    'ld_added_course_group_access',
    function( $user_id, $group_id ) {
        // May add any custom logic using $user_id, $group_id
    },
    10,
    2
);
```

--------------------------------

### WpProQuiz_Helper_Upgrade::install

Source: https://developers.learndash.com/method/wpproquiz_helper_upgrade/install

The install method is responsible for initializing or installing the WpProQuiz helper components.

```APIDOC
## WpProQuiz_Helper_Upgrade::install

### Description
Initializes the installation process for the WpProQuiz helper.

### Source
File: includes/lib/wp-pro-quiz/lib/helper/WpProQuiz_Helper_Upgrade.php
```

--------------------------------

### Example Usage

Source: https://developers.learndash.com/hook/learndash-focus-content-comments-after

Implementation example for the learndash-focus-content-comments-after action.

```php
<?php
/**
 
* Example usage for learndash-focus-content-comments-after action.
 
*/
add_action(
    'learndash-focus-content-comments-after',
    function( $course_id, $user_id ) {
        // May add any custom logic using $course_id, $user_id
    },
    10,
    2
);
```

--------------------------------

### Example Usage

Source: https://developers.learndash.com/hook/learndash-context-quiz-list-after

Implementation example for the lesson context quiz list.

```php
<?php
/**
 * Example usage for learndash-{$context}-quiz-list-after action.
 */
add_action(
    'learndash-lesson-quiz-list-after',
    function( $post_id, $course_id, $user_id ) {
        // May add any custom logic using $post_id, $course_id, $user_id
    },
    10,
    3
);
```

--------------------------------

### Example Usage

Source: https://developers.learndash.com/hook/learndash-course-row-expand-after

Implementation example for the learndash-course-row-expand-after action.

```php
<?php
/**
 * Example usage for learndash-course-row-expand-after action.
 */
add_action(
    'learndash-course-row-expand-after',
    function( $course_id, $user_id ) {
        // May add any custom logic using $course_id, $user_id
    },
    10,
    2
);
```

--------------------------------

### Example Usage

Source: https://developers.learndash.com/hook/learndash-topic-list-after

Implementation example for the learndash-topic-list-after action hook.

```php
<?php
/**
 * Example usage for learndash-topic-list-after action.
 */
add_action(
    'learndash-topic-list-after',
    function( $lesson_id, $course_id, $user_id ) {
        // May add any custom logic using $lesson_id, $course_id, $user_id
    },
    10,
    3
);
```

--------------------------------

### Example Usage for learndash-course-after

Source: https://developers.learndash.com/hook/learndash-course-after

Implementation example for hooking into the learndash-course-after action.

```php
<?php
/**
 * Example usage for learndash-course-after action.
 */
add_action(
    'learndash-course-after',
    function( $post_id, $course_id, $user_id ) {
        // May add any custom logic using $post_id, $course_id, $user_id
    },
    10,
    3
);
```

--------------------------------

### Example Usage of learndash_themes_init

Source: https://developers.learndash.com/hook/learndash_themes_init

Example of how to add an action to the 'learndash_themes_init' hook. Add your custom code within the callback function.

```php
<?php
/**
 * Example usage for learndash_themes_init action.
 */
add_action(
    'learndash_themes_init',
    function() {
        // Add your custom code here
    }
);
```

--------------------------------

### Boot::install

Source: https://developers.learndash.com/files/includes_licensing_src_boot-php

Executes setup scripts during plugin activation.

```APIDOC
## Boot::install

### Description
Run the setup scripts when the plugin is activating.

### Method
Method

### Source File
includes/licensing/src/boot.php

### Since
4.18.0
```

--------------------------------

### API::get_multisite_active_sites()

Source: https://developers.learndash.com/files/includes_licensing_src_component_class-api-php

Gets the count of active sites in a multisite installation.

```APIDOC
## API::get_multisite_active_sites()

### Description
Gets multi-site active site count.

### Method
GET (assumed, as it retrieves data)

### Endpoint
/api/multisite/active-sites/count (assumed)

### Parameters
None explicitly mentioned.

### Request Example
None provided.

### Response
#### Success Response (200)
- active_sites_count (integer) - The number of active sites.

#### Response Example
```json
{
  "active_sites_count": 5
}
```
```

--------------------------------

### Install theme using LearnDash_Design_Wizard

Source: https://developers.learndash.com/method/learndash_design_wizard/install_theme

Use this method to trigger a theme installation by passing the required theme key string.

```php
LearnDash_Design_Wizard::install_theme( string $theme )
```

--------------------------------

### Method: LearnDash_Setup_Wizard::render()

Source: https://developers.learndash.com/files/includes_class-ld-setup-wizard-php

Outputs the HTML root for the React application used in the setup wizard.

```APIDOC
## Method: LearnDash_Setup_Wizard::render()

### Description
Output the html root for react app.

### @since
4.0.0

### @package
LearnDash

### Source Files
includes/class-ld-setup-wizard.php
```

--------------------------------

### Test Setup Methods

Source: https://developers.learndash.com/namespace/tests-learndash

A collection of setup methods used for initializing test environments for LearnDash features.

```APIDOC
## Ld_Setup_Wizard_Test::set_up()

### Description
Initializes the setup environment for the LearnDash Setup Wizard test suite.

### Method
Test setup

## Learndash_Admin_Lesson_Cloning_Test::set_up()

### Description
Initializes the setup environment for the LearnDash Lesson Cloning test suite.

### Method
Test setup

## Learndash_Admin_Quiz_Cloning_Test::set_up()

### Description
Initializes the setup environment for the LearnDash Quiz Cloning test suite.

### Method
Test setup

## Learndash_Admin_Topic_Cloning_Test::set_up()

### Description
Initializes the setup environment for the LearnDash Topic Cloning test suite.

### Method
Test setup
```

--------------------------------

### Deprecated Version Check Function

Source: https://developers.learndash.com/package/deprecated/page/12

Function to get the prior installed version of LearnDash, now deprecated.

```APIDOC
## learndash_get_prior_installed_version()

### Description
Gets the prior installed version.

### @since
3.1.2

### @deprecated
3.1.2

### @package
LearnDash / Deprecated

### Source Files
includes/deprecated/3.1.2/functions.php
```

--------------------------------

### TestCase::set_up()

Source: https://developers.learndash.com/files/tests_phpunit_testcase-php

Performs the basic setup for the test case.

```APIDOC
## TestCase::set_up()

### Description
Basic setup for the test case.

### Method
(Not specified, likely a PHP method within a class)

### Endpoint
(Not applicable for this method)

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
(None)

### Request Example
(Not applicable)

### Response
#### Success Response (200)
(Not applicable)

#### Response Example
(Not applicable)

### @package
LearnDash / Tests

### Source Files
tests/phpunit/TestCase.php
```

--------------------------------

### Learndash_Admin_Pointers::check_setup_wizard_status

Source: https://developers.learndash.com/method/learndash_admin_pointers/check_setup_wizard_status

Checks the status of the setup wizard and modifies pointers accordingly. This function verifies whether the setup wizard has been completed or dismissed. If either is true, it removes the pointer associated with a new LearnDash installation.

```APIDOC
## Learndash_Admin_Pointers::check_setup_wizard_status

### Description
Checks the status of the setup wizard and modifies pointers accordingly. This function verifies whether the setup wizard has been completed or dismissed. If either is true, it removes the pointer associated with a new LearnDash installation.

### Method
(Not specified, likely internal PHP method)

### Endpoint
(Not applicable, this is a PHP function)

### Return
(void)

### Source
File: includes/admin/class-learndash-admin-pointers.php
```

--------------------------------

### LearnDash_Settings_Page_Setup::redirect_overview_to_setup()

Source: https://developers.learndash.com/files/includes_settings_settings-pages_class-ld-settings-page-setup-php

Redirects the old LearnDash overview page to the setup page.

```APIDOC
## LearnDash_Settings_Page_Setup::redirect_overview_to_setup()

### Description
Redirect the old LearnDash overview page to setup page.

### Method
Not specified (likely internal method)

### Endpoint
Not applicable (class method)

### Parameters
None specified

### Request Example
None specified

### Response
Redirection to the setup page.
```

--------------------------------

### Mapper::install()

Source: https://developers.learndash.com/files/includes_licensing_framework_class-abstract-mapper-php

Handles SQL setup scripts for the mapper.

```APIDOC
## Mapper::install()

### Description
Sql setup script should be here.

### Method
POST or PUT (assumed, as it performs setup)

### Endpoint
Not specified, typically an internal method.

### Source Files
includes/licensing/framework/class-abstract-mapper.php
```

--------------------------------

### Get Local Add-on Directory Path - LearnDash_BitBucket_API

Source: https://developers.learndash.com/method/learndash_bitbucket_api/get_addon_directory

Use this method to get the local directory path for add-ons within the LearnDash BitBucket API context. No specific setup is required beyond having the API class available.

```php
LearnDash_BitBucket_API::get_addon_directory()
```

--------------------------------

### Method: LearnDash_Setup_Wizard::redirect_after_activation()

Source: https://developers.learndash.com/files/includes_class-ld-setup-wizard-php

Handles redirection to the setup wizard after plugin activation.

```APIDOC
## Method: LearnDash_Setup_Wizard::redirect_after_activation()

### Description
Redirect to the setup wizard after an activation.

### @since
4.0.0

### @package
LearnDash

### Source Files
includes/class-ld-setup-wizard.php
```

--------------------------------

### Get Post ID - WpProQuiz_Model_Quiz

Source: https://developers.learndash.com/method/wpproquiz_model_quiz/getpostid

Retrieves the post ID associated with the quiz model. No specific setup is required beyond having an instance of the quiz model.

```php
WpProQuiz_Model_Quiz::getPostId()
```

--------------------------------

### Action Hook: learndash_setup_wizard_completed

Source: https://developers.learndash.com/files/includes_class-ld-setup-wizard-php

Action to be run after the setup wizard is completed.

```APIDOC
## Action Hook: learndash_setup_wizard_completed

### Description
Action to be run after the setup wizard is completed.

### @since
4.1.2

### @package
LearnDash

### Source Files
includes/class-ld-setup-wizard.php
```

--------------------------------

### Example Usage of learndash-focus-template-start

Source: https://developers.learndash.com/hook/learndash-focus-template-start

Use this hook to add custom logic when the focus template starts. The $course_id parameter is available for use within your callback function.

```php
<?php
/**
 * Example usage for learndash-focus-template-start action.
 */
add_action(
    'learndash-focus-template-start',
    function( $course_id ) {
        // May add any custom logic using $course_id
    }
);
```

--------------------------------

### Get User Group Started Timestamp

Source: https://developers.learndash.com/function/learndash_get_user_group_started_timestamp

Retrieves the timestamp indicating when a user began a specific group. Requires the group ID and user ID as parameters.

```php
learndash_get_user_group_started_timestamp( integer $group_id,  integer $user_id )
```

--------------------------------

### Method: LearnDash_Setup_Wizard::create_courses_listing_page()

Source: https://developers.learndash.com/files/includes_class-ld-setup-wizard-php

Creates the courses listing page during the setup wizard.

```APIDOC
## Method: LearnDash_Setup_Wizard::create_courses_listing_page()

### Description
Create courses listing page

### @since
4.0.0

### @package
LearnDash

### Source Files
includes/class-ld-setup-wizard.php
```

--------------------------------

### Get Section Title - LearnDash_Shortcodes_Section

Source: https://developers.learndash.com/method/learndash_shortcodes_section/get_shortcodes_section_title

Use this method to retrieve the title for a specific shortcode section. No specific setup or imports are required beyond the class definition.

```php
LearnDash_Shortcodes_Section::get_shortcodes_section_title()
```

--------------------------------

### Action Hook: learndash_initialization_new_install

Source: https://developers.learndash.com/files/src_core_settings_initialization-php

Fires on LearnDash new install initialization.

```APIDOC
## Action Hook: learndash_initialization_new_install

### Description
Fires on LearnDash new install initialization.

### Hook Name
learndash_initialization_new_install

### Package
LearnDash / Core

### Since
4.16.0

### Used By
1 function

### Source Files
src/Core/Settings/Initialization.php
```

--------------------------------

### Get Correct Answer Count - PHP

Source: https://developers.learndash.com/method/wpproquiz_model_statisticformoverview/getcorrectcount

Retrieves the count of correct answers for a given statistic overview. No specific setup or imports are required beyond the class context.

```php
WpProQuiz_Model_StatisticFormOverview::getCorrectCount()
```

--------------------------------

### learndash_table_prefix Filter Hook

Source: https://developers.learndash.com/hook/learndash_table_prefix

The 'learndash_table_prefix' filter allows developers to modify the database table prefix used by LearnDash. This can be useful for custom database setups or multi-site WordPress installations.

```APIDOC
## learndash_table_prefix Filter Hook

### Description
Filters database table prefix.

### Method
apply_filters

### Endpoint
N/A (This is a filter hook, not an API endpoint)

### Parameters
#### Filter Parameters
- **$table_prefix** (string) - Required - The current database table prefix.
- **$table_section** (string) - Required - The section prefix for the table.

### Request Example
```php
<?php
/**
 * Example usage for learndash_table_prefix filter.
 */
add_filter(
    'learndash_table_prefix',
    function( $table_prefix, $table_section ) {
        // May add any custom logic using $table_prefix, $table_section.
        // Always return $table_prefix.
        return $table_prefix;
    },
    10,
    2
);
```

### Response
#### Success Response (200)
- **$table_prefix** (string) - The modified or original database table prefix.
```

--------------------------------

### Method: LearnDash_Setup_Wizard::enqueue_scripts()

Source: https://developers.learndash.com/files/includes_class-ld-setup-wizard-php

Registers the necessary scripts for the setup wizard.

```APIDOC
## Method: LearnDash_Setup_Wizard::enqueue_scripts()

### Description
Register the script

### @since
4.0.0

### @package
LearnDash

### Source Files
includes/class-ld-setup-wizard.php
```

--------------------------------

### SetupIntentService Methods

Source: https://developers.learndash.com/class/stripe-service-setupintentservice

Overview of the available methods for the SetupIntentService class.

```APIDOC
## SetupIntentService Methods

### Description
The SetupIntentService class provides methods to manage the lifecycle of SetupIntent objects in Stripe.

### Methods
- **all**: Returns a list of SetupIntents.
- **cancel**: Cancels a SetupIntent object if it is in a valid status (requires_payment_method, requires_confirmation, or requires_action).
- **confirm**: Confirms that a customer intends to set up the current or provided payment method.
- **create**: Creates a new SetupIntent object.
- **retrieve**: Retrieves the details of an existing SetupIntent.
- **update**: Updates an existing SetupIntent object.
```

--------------------------------

### Example Usage of learndash-course-row-certificate-before Hook

Source: https://developers.learndash.com/hook/learndash-course-row-certificate-before

Use this hook to add custom logic before the course row certificate is displayed. It passes the course ID and user ID as parameters. Ensure you have the LearnDash plugin installed.

```php
<?php
/**
 * Example usage for learndash-course-row-certificate-before action.
 */
add_action(
    'learndash-course-row-certificate-before',
    function( $course_id, $user_id ) {
        // May add any custom logic using $course_id, $user_id
    },
    10,
    2
);
```

--------------------------------

### Use learndash-lesson-after Hook

Source: https://developers.learndash.com/hook/learndash-lesson-after

This example demonstrates how to hook into the 'learndash-lesson-after' action to execute custom code after a lesson. It receives the post ID, course ID, and user ID as parameters. Ensure you have the necessary LearnDash plugin setup.

```php
<?php
/**
 * Example usage for learndash-lesson-after action.
 */
add_action(
    'learndash-lesson-after',
    function ( $post_id, $course_id, $user_id ) {
        // May add any custom logic using $post_id, $course_id, $user_id
    },
    10,
    3
);
```

--------------------------------

### Boot::start

Source: https://developers.learndash.com/files/includes_licensing_src_boot-php

Runs all triggers in the init runtime.

```APIDOC
## Boot::start

### Description
Run all the triggers in init runtime.

### Method
Method

### Source File
includes/licensing/src/boot.php

### Since
4.18.0
```

--------------------------------

### LDLMS_Free_Answer::setup()

Source: https://developers.learndash.com/method/ldlms_free_answer/setup

Overrides the setup method in the parent class to add necessary hooks and call other setup actions for the Free Answer type.

```APIDOC
## LDLMS_Free_Answer::setup

### Description

Overrides the setup method in the parent class. This method is responsible for adding necessary hooks and calling other setup actions specific to the Free Answer type.

### Method

```php
LDLMS_Free_Answer::setup()
```

### Endpoint

N/A (This is a class method, not an API endpoint)

### Parameters

This method does not accept any parameters.

### Request Body

N/A

### Response

#### Success Response (void)

This method does not return any value.

### Source

File: includes/classes/answer-types/class-ldlms-free-answer-type.php

### Related

- **@package**: LearnDash / Question / Free
- **Uses**: includes/classes/answer-types/class-ldlms-base-answer-type.php: LDLMS_Base_Answer_Type::setup ()
```

--------------------------------

### Use learndash-nav-after-inner-section-heading Hook

Source: https://developers.learndash.com/hook/learndash-nav-after-inner-section-heading

This example demonstrates how to hook into the 'learndash-nav-after-inner-section-heading' action. It allows you to add custom logic using the provided section, course ID, and user ID parameters. Ensure you have the necessary LearnDash setup for this hook to function.

```php
<?php
/**
 * Example usage for learndash-nav-after-inner-section-heading action.
 */
add_action(
    'learndash-nav-after-inner-section-heading',
    function( $section, $course_id, $user_id ) {
        // May add any custom logic using $section, $course_id, $user_id
    },
    10,
    3
);
```

--------------------------------

### Example Usage

Source: https://developers.learndash.com/hook/learndash-context-progress-bar-before

Demonstrates how to hook into the lesson progress bar context.

```php
<?php
/**
 * Example usage for learndash-{$context}-progress-bar-before action.
 */
add_action(
    'learndash-lesson-progress-bar-before',
    function( $course_id, $user_id ) {
        // May add any custom logic using $course_id, $user_id
    },
    10,
    2
);
```

--------------------------------

### Example Usage of learndash-quiz-after Hook

Source: https://developers.learndash.com/hook/learndash-quiz-after

Use this hook to execute custom functions after the quiz content has started. It passes the quiz ID, course ID, and user ID to the callback function. Ensure the callback function accepts these three arguments.

```php
<?php
/**
 * Example usage for learndash-quiz-after action.
 */
add_action(
    'learndash-quiz-after',
    function ( $quiz_id, $course_id, $user_id ) {
        // May add any custom logic using $quiz_id, $course_id, $user_id
    },
    10,
    3
);
```

--------------------------------

### Learndash_Admin_Course_Cloning_Test::set_up() Method

Source: https://developers.learndash.com/package/tests/page/6

Details the setup method for the Learndash_Admin_Course_Cloning_Test class.

```APIDOC
## Method Learndash_Admin_Course_Cloning_Test::set_up()

### Description
Test setup

### Package
LearnDash / Tests

### Source Files
tests/phpunit/includes/admin/classes-cloning/learndash_admin_course_cloning_test.php
```

--------------------------------

### Method: LearnDash_Setup_Wizard::get_scenes()

Source: https://developers.learndash.com/files/includes_class-ld-setup-wizard-php

Retrieves the list of scenes available in the setup wizard.

```APIDOC
## Method: LearnDash_Setup_Wizard::get_scenes()

### Description
Get the list of scenes.

### @since
4.0.0

### @package
LearnDash

### Source Files
includes/class-ld-setup-wizard.php
```

--------------------------------

### Method: LearnDash_Setup_Wizard::should_display()

Source: https://developers.learndash.com/files/includes_class-ld-setup-wizard-php

Determines if the setup wizard should be displayed, typically based on the presence of a license key.

```APIDOC
## Method: LearnDash_Setup_Wizard::should_display()

### Description
If there is no license key stored in the database, then we should show up the wizard

### @since
4.0.0

### @package
LearnDash

### Source Files
includes/class-ld-setup-wizard.php
```

--------------------------------

### Example Usage for learndash_mark_complete

Source: https://developers.learndash.com/hook/learndash_completion_redirect

Example demonstrating how to hook into the completion process. Note that this example uses the 'learndash_mark_complete' filter rather than the deprecated hook.

```php
<?php
/**
 * Example usage for learndash_mark_complete filter.
 */
add_filter(
    'learndash_mark_complete',
    function( $return, $post ) {
        // May add any custom logic using $return, $post.
        // Always return $return.
        return $return;
    },
    10,
    2
);
```

--------------------------------

### Learndash_Admin_Import_Media_Test::set_up()

Source: https://developers.learndash.com/namespace/tests-learndash-5

Sets up the testing environment for the Learndash_Admin_Import_Media_Test class.

```APIDOC
## Learndash_Admin_Import_Media_Test::set_up()

### Description
Test setup.

### Method
N/A (This is a method within a test class)

### Endpoint
N/A (This is a method within a test class)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
None
```

--------------------------------

### Example Usage

Source: https://developers.learndash.com/hook/learndash-topic-row-before

Implementation example for the learndash-topic-row-before action.

```php
<?php
/**
 * Example usage for learndash-topic-row-before action.
 */
add_action(
    'learndash-topic-row-before',
    function( $topic_id, $course_id, $user_id ) {
        // May add any custom logic using $topic_id, $course_id, $user_id
    },
    10,
    3
);
```

--------------------------------

### Method: LearnDash_Setup_Wizard::create_registration_pages()

Source: https://developers.learndash.com/files/includes_class-ld-setup-wizard-php

Creates registration, registration success, reset password, and profile pages.

```APIDOC
## Method: LearnDash_Setup_Wizard::create_registration_pages()

### Description
Create registration, registration success, reset password and profile pages.

### @since
4.0.0

### @package
LearnDash

### Source Files
includes/class-ld-setup-wizard.php
```

--------------------------------

### Method: LearnDash_Setup_Wizard::register_menu()

Source: https://developers.learndash.com/files/includes_class-ld-setup-wizard-php

Registers the setup wizard as an admin page in the WordPress menu.

```APIDOC
## Method: LearnDash_Setup_Wizard::register_menu()

### Description
Register the admin page to the tree.

### @since
4.0.0

### @package
LearnDash

### Source Files
includes/class-ld-setup-wizard.php
```

--------------------------------

### Example Usage

Source: https://developers.learndash.com/hook/learndash-context-infobar-inside-before

Demonstrates how to hook into the lesson infobar context.

```php
<?php
/**
 * Example usage for learndash-{$context}-infobar-inside-before action.
 */
add_action(
    'learndash-lesson-infobar-inside-before',
    function( $course_id, $user_id ) {
        // May add any custom logic using $course_id, $user_id
    },
    10,
    2
);
```

--------------------------------

### Learndash_Admin_Import_Taxonomies_Test::set_up()

Source: https://developers.learndash.com/files/tests_phpunit_includes_admin_classes-import-export_import_learndash_admin_import_taxonomies_test-php

Method to initialize the test environment.

```APIDOC
## Learndash_Admin_Import_Taxonomies_Test::set_up()

### Description
Test setup method for the import taxonomies test suite.
```

--------------------------------

### Example Usage

Source: https://developers.learndash.com/hook/learndash-assignment-row-before

Implementation example for the learndash-assignment-row-before action.

```php
<?php
/**
 * Example usage for learndash-assignment-row-before action.
 */
add_action(
    'learndash-assignment-row-before',
    function( $assignment, $post_id, $course_id, $user_id ) {
        // May add any custom logic using $assignment, $post_id, $course_id, $user_id
    },
    10,
    4
);
```

--------------------------------

### LearnDash_Settings_Page_Setup::show_settings_page

Source: https://developers.learndash.com/method/learndash_settings_page_setup/show_settings_page

Outputs the HTML for the LearnDash settings setup page.

```APIDOC
## LearnDash_Settings_Page_Setup::show_settings_page

### Description
Outputs the page HTML for the LearnDash settings setup page.

### Source
File: includes/settings/settings-pages/class-ld-settings-page-setup.php

### Return
- (void)

### Changelog
- 4.4.0: Introduced.
```

--------------------------------

### Learndash_Admin_Export_Configuration_Test::set_up()

Source: https://developers.learndash.com/files/tests_phpunit_includes_admin_classes-import-export_export_learndash_admin_export_configuration_test-php

Method to handle test setup.

```APIDOC
## Learndash_Admin_Export_Configuration_Test::set_up()

### Description
Test setup method for the configuration export test suite.
```

--------------------------------

### Example Usage

Source: https://developers.learndash.com/hook/learndash-assignment-row-slug-before

Implementation example for the comments column slug.

```php
<?php
/**
 * Example usage for learndash-assignment-row-{$slug}-before action.
 */
add_action(
    'learndash-assignment-row-comments-before',
    function( $assignment, $post_id, $course_id, $user_id ) {
        // May add any custom logic using $assignment, $post_id, $course_id, $user_id
    },
    10,
    4
);
```

--------------------------------

### LearnDash_Settings_Page_Setup::show_settings_page()

Source: https://developers.learndash.com/files/includes_settings_settings-pages_class-ld-settings-page-setup-php

Outputs the HTML for the settings page.

```APIDOC
## LearnDash_Settings_Page_Setup::show_settings_page()

### Description
Outputs the page HTML.

### Method
Not specified (likely internal method)

### Endpoint
Not applicable (class method)

### Parameters
None specified

### Request Example
None specified

### Response
HTML output for the settings page.
```

--------------------------------

### Ld_Course_Wizard_Test::set_up()

Source: https://developers.learndash.com/files/tests_phpunit_includes_ld_course_wizard_test-php

Method used to perform test setup operations.

```APIDOC
## Ld_Course_Wizard_Test::set_up()

### Description
Test setup method for the LearnDash Course Wizard test suite.

### Source File
tests/phpunit/includes/ld_course_wizard_test.php
```

--------------------------------

### Example Usage for learndash_element_lazy_load_admin_filters

Source: https://developers.learndash.com/hook/learndash_course_post_options_filter

This example demonstrates how to use a related filter 'learndash_element_lazy_load_admin_sfwd-topic_filters'. It's provided as an extended example for the deprecated hook. Always return the $lazy_load variable.

```php
<?php
/**
 * Example usage for learndash_element_lazy_load_admin_{$_GET['post_type']}_filters filter.
 */
add_filter(
    'learndash_element_lazy_load_admin_sfwd-topic_filters',
    function ( $lazy_load ) {
        // May add any custom logic using $lazy_load.
        // Always return $lazy_load.
        return $lazy_load;
    }
);
```

--------------------------------

### LearnDash_Setup_Wizard Methods and Hooks

Source: https://developers.learndash.com/files/includes_class-ld-setup-wizard-php

A collection of methods and filters related to the LearnDash Setup Wizard functionality.

```APIDOC
## LearnDash_Setup_Wizard::set_redirect_flag()

### Description
Checks when the setup wizard needs to be displayed and sets an option flag accordingly.

### Method
Class Method

### Source File
includes/class-ld-setup-wizard.php

---

## LearnDash_Setup_Wizard::create_profile_page()

### Description
Creates the user profile page during the completion of the Setup Wizard.

### Method
Class Method

### Source File
includes/class-ld-setup-wizard.php

---

## learndash_setup_wizard_should_display

### Description
Filter hook to determine whether the setup wizard should be displayed to the user.

### Method
Filter Hook

### Source File
includes/class-ld-setup-wizard.php

---

## LearnDash_Setup_Wizard::get_completed_redirect_url()

### Description
Retrieves the URL to which the user should be redirected after the wizard is completed.

### Method
Class Method

### Source File
includes/class-ld-setup-wizard.php

---

## learndash_setup_wizard_completed_redirect_url

### Description
Filter hook to modify the URL used for redirection after the setup wizard is completed.

### Method
Filter Hook

### Source File
includes/class-ld-setup-wizard.php
```

--------------------------------

### SetupIntent Class

Source: https://developers.learndash.com/files/includes_lib_stripe-php_lib_setupintent-php

Documentation for the SetupIntent class, which guides the process of setting up and saving customer payment credentials for future payments.

```APIDOC
## Class SetupIntent

### Description
A SetupIntent guides you through the process of setting up and saving a customer’s payment credentials for future payments. For example, you could use a SetupIntent to set up and save your customer’s card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

### Source Files
- includes/lib/stripe-php/lib/SetupIntent.php
```

--------------------------------

### Example usage for ld_removed_group_access

Source: https://developers.learndash.com/hook/ld_removed_group_access

Implementation example for hooking into the ld_removed_group_access action.

```php
<?php
/**
 * Example usage for ld_removed_group_access action.
 */
add_action(
    'ld_removed_group_access',
    function( $user_id, $group_id ) {
        // May add any custom logic using $user_id, $group_id
    },
    10,
    2
);
```

--------------------------------

### Projects::install()

Source: https://developers.learndash.com/files/includes_licensing_src_component_class-projects-php

Installs a project.

```APIDOC
## Projects::install()

### Description
Install a project.

### Method
Not specified

### Endpoint
Not specified

### Parameters
None specified

### Request Example
None specified

### Response
None specified
```

--------------------------------

### LearnDash_Settings_Page_Setup::__construct()

Source: https://developers.learndash.com/files/includes_settings_settings-pages_class-ld-settings-page-setup-php

Public constructor for the LearnDash_Settings_Page_Setup class.

```APIDOC
## LearnDash_Settings_Page_Setup::__construct()

### Description
Public constructor for class.

### Method
Constructor

### Endpoint
Not applicable (class method)

### Parameters
None specified

### Request Example
None specified

### Response
Initializes the LearnDash_Settings_Page_Setup object.
```

--------------------------------

### Example Usage of learndash-{$context}-infobar-inside-after

Source: https://developers.learndash.com/hook/learndash-context-infobar-inside-after

Example usage for the learndash-{$context}-infobar-inside-after action hook. This example demonstrates how to add custom logic using the provided parameters.

```php
<?php
/**
 * Example usage for learndash-{$context}-infobar-inside-after action.
 */
add_action(
    'learndash-lesson-infobar-inside-after',
    function ( $post_type, $course_id, $user_id ) {
        // May add any custom logic using $post_type, $course_id, $user_id
    },
    10,
    3
);
```

--------------------------------

### Example Usage of learndash_addon_display_rows_{$this->current_tab} Hook

Source: https://developers.learndash.com/hook/learndash_addon_display_rows_this-current_tab

Example of how to hook into the learndash_addon_display_rows_{$this->current_tab} action. This example hooks into the 'learndash' tab. Ensure you consult a developer for complex implementations.

```php
<?php
/**
 * Example usage for learndash_addon_display_rows_{$this->current_tab} action.
 */
add_action(
    'learndash_addon_display_rows_learndash',
    function() {
        // Add your custom code here
    }
);
```

--------------------------------

### LearnDash_Setup_Wizard::create_profile_page

Source: https://developers.learndash.com/method/learndash_setup_wizard/create_profile_page

Creates the profile page during the completion of the LearnDash Setup Wizard process.

```APIDOC
## LearnDash_Setup_Wizard::create_profile_page

### Description
Creates the profile page during the completion of the LearnDash Setup Wizard process.

### Source
File: includes/class-ld-setup-wizard.php

### Return
(void)

### Changelog
| Version | Description |
| --- | --- |
| 4.4.1 | Introduced. |
```

--------------------------------

### Example Usage

Source: https://developers.learndash.com/hook/learndash_settings_page_inside_form_bottom

Implementation example for attaching a function to the hook using add_action.

```php
<?php
/**
 
* Example usage for learndash_settings_page_inside_form_bottom action.
 
*/
add_action(
    'learndash_settings_page_inside_form_bottom',
    function( $setting_screen_id, $setting_page_id ) {
        // May add any custom logic using $setting_screen_id, $setting_page_id
    },
    10,
    2
);
```

--------------------------------

### Example Usage

Source: https://developers.learndash.com/hook/learndash_metabox_description_before

Demonstrates how to hook into the action to execute custom logic.

```php
<?php
/**
 * Example usage for learndash_metabox_description_before action.
 */
add_action(
    'learndash_metabox_description_before',
    function( $settings_key ) {
        // May add any custom logic using $settings_key
    }
);
```

--------------------------------

### Example Usage

Source: https://developers.learndash.com/hook/learndash_metabox_options_div_after

Demonstrates how to hook into the action to execute custom logic.

```php
<?php
/**
 * Example usage for learndash_metabox_options_div_after action.
 */
add_action(
    'learndash_metabox_options_div_after',
    function( $settings_key ) {
        // May add any custom logic using $settings_key
    }
);
```

--------------------------------

### Theme Installation and Activation

Source: https://developers.learndash.com/files/includes_class-ld-design-wizard-php

Methods for installing and activating themes within LearnDash.

```APIDOC
## POST /learndash/design-wizard/install-theme

### Description
Installs a theme using the LearnDash Design Wizard.

### Method
POST

### Endpoint
/learndash/design-wizard/install-theme

### Parameters
#### Request Body
- **theme_slug** (string) - Required - The slug of the theme to install.

### Request Example
{
  "theme_slug": "example-theme"
}

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the theme installation was successful.
- **message** (string) - A message describing the result of the installation.

#### Response Example
{
  "success": true,
  "message": "Theme installed successfully."
}

## POST /learndash/design-wizard/activate-theme

### Description
Activates a previously installed theme.

### Method
POST

### Endpoint
/learndash/design-wizard/activate-theme

### Parameters
#### Request Body
- **theme_slug** (string) - Required - The slug of the theme to activate.

### Request Example
{
  "theme_slug": "example-theme"
}

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the theme activation was successful.
- **message** (string) - A message describing the result of the activation.

#### Response Example
{
  "success": true,
  "message": "Theme activated successfully."
}
```

--------------------------------

### Plugin Installation and Activation

Source: https://developers.learndash.com/files/includes_class-ld-design-wizard-php

Methods for installing and activating plugins within LearnDash.

```APIDOC
## POST /learndash/design-wizard/install-plugin

### Description
Installs a plugin using the LearnDash Design Wizard.

### Method
POST

### Endpoint
/learndash/design-wizard/install-plugin

### Parameters
#### Request Body
- **plugin_slug** (string) - Required - The slug of the plugin to install.

### Request Example
{
  "plugin_slug": "example-plugin"
}

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the plugin installation was successful.
- **message** (string) - A message describing the result of the installation.

#### Response Example
{
  "success": true,
  "message": "Plugin installed successfully."
}

## POST /learndash/design-wizard/install-plugin-fallback

### Description
Fallback method to install a plugin from a ZIP file.

### Method
POST

### Endpoint
/learndash/design-wizard/install-plugin-fallback

### Parameters
#### Request Body
- **zip_file** (file) - Required - The ZIP file containing the plugin.

### Request Example
(File upload)

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the plugin installation was successful.
- **message** (string) - A message describing the result of the installation.

#### Response Example
{
  "success": true,
  "message": "Plugin installed successfully from ZIP file."
}

## POST /learndash/design-wizard/activate-plugin

### Description
Activates a previously installed plugin.

### Method
POST

### Endpoint
/learndash/design-wizard/activate-plugin

### Parameters
#### Request Body
- **plugin_slug** (string) - Required - The slug of the plugin to activate.

### Request Example
{
  "plugin_slug": "example-plugin"
}

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the plugin activation was successful.
- **message** (string) - A message describing the result of the activation.

#### Response Example
{
  "success": true,
  "message": "Plugin activated successfully."
}
```

--------------------------------

### Learndash_Admin_Export_Post_Type_Settings_Test::set_up()

Source: https://developers.learndash.com/files/tests_phpunit_includes_admin_classes-import-export_export_learndash_admin_export_post_type_settings_test-php

Setup method for the test suite.

```APIDOC
## Learndash_Admin_Export_Post_Type_Settings_Test::set_up()

### Description
Test setup method for the Learndash_Admin_Export_Post_Type_Settings_Test class.

### Source File
tests/phpunit/includes/admin/classes-import-export/export/learndash_admin_export_post_type_settings_test.php
```

--------------------------------

### LearnDash_Setup_Wizard::__construct()

Source: https://developers.learndash.com/files/includes_class-ld-setup-wizard-php/page/2

Details the constructor for the LearnDash Setup Wizard class, responsible for creating a single instance.

```APIDOC
## LearnDash_Setup_Wizard::__construct()

### Description
The single instance of the class.

### @since
4.0.0

### @package
LearnDash

### Source Files
includes/class-ld-setup-wizard.php
```

--------------------------------

### Activity Start Functions

Source: https://developers.learndash.com/package/activity

Functions to mark the start of various learning activities.

```APIDOC
## POST /api/learndash/activity/start/topic

### Description
Sets the topic activity started record for a user.

### Method
POST

### Endpoint
/api/learndash/activity/start/topic

### Parameters
#### Request Body
- **user_id** (int) - Required - The ID of the user.
- **topic_id** (int) - Required - The ID of the topic.

### Request Example
{
  "user_id": 123,
  "topic_id": 456
}

### Response
#### Success Response (200)
- **status** (string) - Indicates success or failure.

#### Response Example
{
  "status": "success"
}
```

```APIDOC
## POST /api/learndash/activity/start/quiz

### Description
Sets the quiz activity started record for a user.

### Method
POST

### Endpoint
/api/learndash/activity/start/quiz

### Parameters
#### Request Body
- **user_id** (int) - Required - The ID of the user.
- **quiz_id** (int) - Required - The ID of the quiz.

### Request Example
{
  "user_id": 123,
  "quiz_id": 789
}

### Response
#### Success Response (200)
- **status** (string) - Indicates success or failure.

#### Response Example
{
  "status": "success"
}
```

```APIDOC
## POST /api/learndash/activity/start/lesson

### Description
Sets the lesson activity started record for a user.

### Method
POST

### Endpoint
/api/learndash/activity/start/lesson

### Parameters
#### Request Body
- **user_id** (int) - Required - The ID of the user.
- **lesson_id** (int) - Required - The ID of the lesson.

### Request Example
{
  "user_id": 123,
  "lesson_id": 101
}

### Response
#### Success Response (200)
- **status** (string) - Indicates success or failure.

#### Response Example
{
  "status": "success"
}
```

```APIDOC
## POST /api/learndash/activity/start/step

### Description
Sets the step activity started record for a user.

### Method
POST

### Endpoint
/api/learndash/activity/start/step

### Parameters
#### Request Body
- **user_id** (int) - Required - The ID of the user.
- **step_id** (int) - Required - The ID of the step.

### Request Example
{
  "user_id": 123,
  "step_id": 112
}

### Response
#### Success Response (200)
- **status** (string) - Indicates success or failure.

#### Response Example
{
  "status": "success"
}
```

```APIDOC
## POST /api/learndash/activity/start/course

### Description
Sets the course activity started record for a user.

### Method
POST

### Endpoint
/api/learndash/activity/start/course

### Parameters
#### Request Body
- **user_id** (int) - Required - The ID of the user.
- **course_id** (int) - Required - The ID of the course.

### Request Example
{
  "user_id": 123,
  "course_id": 131
}

### Response
#### Success Response (200)
- **status** (string) - Indicates success or failure.

#### Response Example
{
  "status": "success"
}
```

--------------------------------

### LdPaymentsFunctionsTest::set_up()

Source: https://developers.learndash.com/files/tests_phpunit_includes_payments_ldpaymentsfunctionstest-php

Sets up the testing environment for LdPaymentsFunctionsTest.

```APIDOC
## LdPaymentsFunctionsTest::set_up()

### Description
Test setup method for the LdPaymentsFunctionsTest class.

### Method
SETUP

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

### Source Files
tests/phpunit/includes/payments/LdPaymentsFunctionsTest.php

### @package
LearnDash
```

--------------------------------

### Example: Add Custom Widget to Sidebar

Source: https://developers.learndash.com/hook/learndash-focus-sidebar-nav-before

Example demonstrating how to use the 'learndash-focus-sidebar-nav-before' hook to add a custom widget with styling to the sidebar navigation. This example modifies the widget title and uses the 'LearnDash_Course_Forum_Widget'.

```php
<?php
/**
 * Example usage for learndash-focus-sidebar-nav-before action.
 */
add_action( 'learndash-focus-sidebar-nav-before',  'ld_add_forum_widget', 10, 3 );
function ld_add_forum_widget( $course_id, $user_id ) {
    ?>
        <style>
            /* You can modify the widget styling here */
            .ld-focus .widget_ldcourseprogress {
                padding: .75em 3.125em .75em 1em;
                background-color: #eee;
                margin-bottom: 0.75em;
            }
        </style>
    <?php
    // Modify the widget title here
    $widget_title = 'Discussion Boards';
    the_widget( 'LearnDash_Course_Forum_Widget', array( 'title' => $widget_title ) );
};
```

--------------------------------

### LDLMS_Base_Answer_Type::setup()

Source: https://developers.learndash.com/files/includes_classes_answer-types_class-ldlms-base-answer-type-php

Adds necessary hooks and calls other setup actions.

```APIDOC
## LDLMS_Base_Answer_Type::setup()

### Description
Add necessary hooks, call other setup actions.

### Method
Not specified (likely a class method)

### Endpoint
Not applicable (class method)

### Parameters
None specified

### Request Example
None specified

### Response
None specified
```

--------------------------------

### learndash_get_lesson_topic_paged_values()

Source: https://developers.learndash.com/files/includes_course_ld-course-functions-php/page/2

Gets the lesson topic pagination values from the HTTP GET global array.

```APIDOC
## learndash_get_lesson_topic_paged_values()

### Description
Gets the lesson topic pagination values from the HTTP GET global array.

### Method
FUNCTION

### Endpoint
N/A

### @since
3.0.0

### @package
LearnDash / Course

### Source Files
includes/course/ld-course-functions.php
```