do_settings_sections

Home » Functions » do_settings_sections

Function Name: do_settings_sections

The do_settings_sections() function is a built-in WordPress function that displays all the sections and fields that have been registered on a settings page. It is primarily used to render the settings page by displaying all the settings sections and fields.

This function takes only one parameter, which is the slug name of the settings page to display. It will call the registered callback functions for each section and display the fields associated with them.

In simpler terms, the do_settings_sections() function allows developers to easily render the settings page on the front-end by displaying all the registered settings fields and sections.

Example Usage:

Let’s say we have a settings page with the slug name "my_settings_page" and it has two sections, "General Settings" and "Advanced Settings". Each section has two fields, "title" and "description". We can call the do_settings_sections function to render the settings page like this:

function my_settings_page() {
  ?>
  <div class="wrap">
    <h1>My Settings Page</h1>
    <form method="post" action="options.php">
      <?php
        settings_fields( 'my_settings_group' );
        do_settings_sections( 'my_settings_page' );
        submit_button();
      ?>
    </form>
  </div>
  <?php
}

function my_settings_callback() {
  // Register settings sections and fields here
}

add_action( 'admin_init', 'my_settings_callback' );
add_action( 'admin_menu', 'my_settings_page' );

This code will display all the sections and fields registered on the "my_settings_page" settings page.

Note: the settings_fields() function is used to generate the hidden input fields required for WordPress to manage the settings data. The submit_button() function is used to generate the submit button that will save the settings data.

Learn More on WordPress.org

Register an account to save your snippets or go Pro to get more features.