Browse: Home / Functions /

learndash_ob_get_clean

learndash_ob_get_clean( int $level )

Helper function for PHP output buffering.

Contents

Description #

Cleans nested output buffers down to a specified level. The loop counter prevents infinite loops by limiting iterations to 10, providing a safety mechanism in case of unexpected buffer handling issues.

Example usage:

$initial_level = ob_get_level(); // Level 1.

ob_start();
echo 'Outer content';            // Level 2.

ob_start();
echo 'Middle content';           // Level 3.

ob_start();
echo 'Inner content';            // Level 4.

// Clean all buffers down to level 1 (return to initial level).
$content = learndash_ob_get_clean( $initial_level );
// Returns: 'Outer content' (the last/outermost buffer cleaned).

// Clean only down to level 2 (leave the outer buffer).
$content = learndash_ob_get_clean( 2 );
// Returns: 'Middle content' (the last buffer cleaned before stopping).

Parameters #

$level

(int) (Optional) The target buffer level to stop at. Default 0 (clean all buffers).

Return #

(string) Content from the last (outermost) buffer that was cleaned, or empty string if no buffers were cleaned.

Source #

File: includes/ld-misc-functions.php

Changelog #

Changelog
Version Description
2.1.0 Introduced.

Used By #

Used By
Used By Description
includes/class-ld-lms.php: SFWD_LMS::get_view ()

Get or output view template file.
includes/shortcodes/ld_reset_password.php: learndash_reset_password ()

Builds the [ld_reset_password] shortcode output.
includes/shortcodes/ld_quiz.php: learndash_quiz_shortcode_function ()

Builds the [ld_quiz] shortcode output.
includes/shortcodes/ld_navigation.php: learndash_navigation_shortcode ()

Builds the [ld_navigation] shortcode output.
includes/shortcodes/ld_registration.php: learndash_registration ()

Builds the [ld_registration] shortcode output.
includes/course/ld-course-info-widget.php: learndash_ajax_course_navigation_admin_pager ()

Handles the AJAX pagination for the admin courses navigation.
includes/course/ld-course-info-widget.php: learndash_ajax_course_registered_pager ()

Handles the AJAX pagination for the courses registered.
includes/course/ld-course-info-widget.php: learndash_ajax_course_progress_pager ()

Handles the AJAX pagination for the course progress.
includes/course/ld-course-info-widget.php: learndash_ajax_quiz_progress_pager ()

Handles the AJAX pagination for the quiz progress.
includes/course/ld-course-info-widget.php: learndash_ajax_course_navigation_pager ()

Handles the AJAX pagination for the courses navigation.
includes/ld-misc-functions.php: learndash_get_db_user_grants ()

Gets the MySQL privileges for the DB_USER defined in the wp-config.
includes/class-ld-lms.php: SFWD_LMS::get_template ()

Get LearnDash template and pass data to be used in template
includes/shortcodes/ld_group_user_list.php: learndash_group_user_list ()

Group user list
includes/class-ld-cpt-instance.php: SFWD_CPT_Instance::template_content ()

Generate output for courses, lessons, topics, quizzes Filter callback for ‘the_content’ (wp core filter)
includes/settings/settings-metaboxes/class-ld-settings-metabox-quiz-results-display-content-options.php: LearnDash_Settings_Metabox_Quiz_Results_Options::get_custom_result_messages ()

Get custom results messages
includes/settings/settings-fields/class-ld-settings-fields-select.php: LearnDash_Settings_Fields_Select::create_section_field ()

Function to crete the settings field.
includes/settings/settings-fields/class-ld-settings-fields-checkbox-switch.php: LearnDash_Settings_Fields_Checkbox_Switch::create_section_field ()

Function to crete the settings field.
includes/settings/settings-fields/class-ld-settings-fields-radio.php: LearnDash_Settings_Fields_Radio::create_section_field ()

Function to crete the settings field.
includes/lib/wp-pro-quiz/lib/view/WpProQuiz_View_FrontQuiz.php: WpProQuiz_View_FrontQuiz::showQuizBox ()
includes/shortcodes/ld_course_content.php: learndash_course_content_shortcode ()

Builds the [course_content] shortcode output.
includes/shortcodes/ld_course_list.php: ld_course_list ()

Builds the [ld_course_list] shortcode output.