WP_Widget::get_field_id( string $field_name ): string

Constructs id attributes for use in WP_Widget::form() fields.

Description

This function should be used in form() methods to create id attributes for fields to be saved by WP_Widget::update().

Parameters

$field_namestringrequired
Field name.

Return

string ID attribute for $field_name.

Source

public function get_field_id( $field_name ) {
	$field_name = str_replace( array( '[]', '[', ']' ), array( '', '-', '' ), $field_name );
	$field_name = trim( $field_name, '-' );

	return 'widget-' . $this->id_base . '-' . $this->number . '-' . $field_name;
}

Changelog

VersionDescription
4.4.0Array format field IDs are now accepted.
2.8.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.