WP_Widget::get_field_name( string $field_name )

Constructs name attributes for use in form() fields


Description Description

This function should be used in form() methods to create name attributes for fields to be saved by update()


Parameters Parameters

$field_name

(string) (Required) Field name


Top ↑

Return Return

(string) Name attribute for $field_name


Top ↑

Source Source

File: wp-includes/class-wp-widget.php

	public function get_field_name($field_name) {
		if ( false === $pos = strpos( $field_name, '[' ) ) {
			return 'widget-' . $this->id_base . '[' . $this->number . '][' . $field_name . ']';
		} else {
			return 'widget-' . $this->id_base . '[' . $this->number . '][' . substr_replace( $field_name, '][', $pos, strlen( '[' ) );
		}
	}


Top ↑

Changelog Changelog

Changelog
Version Description
4.4.0 Array format field names are now accepted.
2.8.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

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