WP_Widget::get_field_name() WordPress Method
The WP_Widget::get_field_name() method is used to retrieve the name attribute for a given field id. This is useful for creating form fields that have multiple values.
WP_Widget::get_field_name( string $field_name ) #
Constructs name attributes for use in form() fields
Description
This function should be used in form() methods to create name attributes for fields to be saved by update()
Parameters
- $field_name
(string)(Required)Field name.
Return
(string) Name attribute for $field_name.
Source
File: wp-includes/class-wp-widget.php
public function get_field_name( $field_name ) {
$pos = strpos( $field_name, '[' );
if ( false !== $pos ) {
// Replace the first occurrence of '[' with ']['.
$field_name = '[' . substr_replace( $field_name, '][', $pos, strlen( '[' ) );
} else {
$field_name = '[' . $field_name . ']';
}
return 'widget-' . $this->id_base . '[' . $this->number . ']' . $field_name;
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 4.4.0 | Array format field names are now accepted. |
| 2.8.0 | Introduced. |