do_settings_sections() │ WP 2.7.0

Outputs to the screen all option blocks related to the specified settings page in the admin panel.

Use this in a settings page callback function to output all the sections and fields that were added to that $page with add_settings_section() and add_settings_field().

Note: the function will output section headers in an H3 tag and form fields in a table.

The function works in conjunction with other functions of the Settings API.

Uses: do_settings_fields()

No Hooks.

Returns

null. Outputs to the screen the HTML code of the blocks with form fields.

Usage

do_settings_sections( $page );
$page(string) (required)
Identifier of the admin panel page on which to output the option blocks. Must match the $page parameter from add_settings_section( $id, $title, $callback, $page ).

Examples

0

#1 Displaying settings sections on the settings page

Suppose we registered new options, added a block and fields to this block. Now, we need to display these fields on the settings page of the plugin in the admin panel, then use this function:

<div class="wrap">  
	<?php screen_icon(); ?>  
	<h2>Primer plugin settings</h2>  

	<form action="options.php" method="POST">  
		<?php settings_fields( 'option_id' ); ?>
		<?php do_settings_sections( 'primer_page' ); ?> 
		<?php submit_button(); ?>  
	</form>  
</div>

See the Settings API for a full example of how to use it.

Notes

  • Global. Array. $wp_settings_sections Storage array of all settings sections added to admin pages.
  • Global. Array. $wp_settings_fields Storage array of settings fields and info about their pages/sections.

Changelog

Since 2.7.0 Introduced.

do_settings_sections() code WP 7.0

wp-admin/includes/template.php 
function do_settings_sections( $page ) {
	global $wp_settings_sections, $wp_settings_fields;

	if ( ! isset( $wp_settings_sections[ $page ] ) ) {
		return;
	}

	foreach ( (array) $wp_settings_sections[ $page ] as $section ) {
		if ( '' !== $section['before_section'] ) {
			if ( '' !== $section['section_class'] ) {
				echo wp_kses_post( sprintf( $section['before_section'], esc_attr( $section['section_class'] ) ) );
			} else {
				echo wp_kses_post( $section['before_section'] );
			}
		}

		if ( $section['title'] ) {
			echo "<h2>{$section['title']}</h2>\n";
		}

		if ( $section['callback'] ) {
			call_user_func( $section['callback'], $section );
		}

		if ( isset( $wp_settings_fields[ $page ][ $section['id'] ] ) ) {
			echo '<table class="form-table" role="presentation">';
			do_settings_fields( $page, $section['id'] );
			echo '</table>';
		}

		if ( '' !== $section['after_section'] ) {
			echo wp_kses_post( $section['after_section'] );
		}
	}
}

Settings API