settings_fields() WordPress Function

The settings_fields() function is used to render the hidden fields required for a settings page. This function should be called inside the form tag on a settings page. The first parameter is the group name of the settings being saved, which should match the group name used in the register_setting() function. The second parameter is the name of the nonce field used to validate the settings form.

settings_fields( string $option_group ) #

Outputs nonce, action, and option_page fields for a settings page.


Parameters

$option_group

(string)(Required)A settings group name. This should match the group name used in register_setting().


Top ↑

Source

File: wp-admin/includes/plugin.php

function settings_fields( $option_group ) {
	echo "<input type='hidden' name='option_page' value='" . esc_attr( $option_group ) . "' />";
	echo '<input type="hidden" name="action" value="update" />';
	wp_nonce_field( "$option_group-options" );
}


Top ↑

Changelog

Changelog
VersionDescription
2.7.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.