WP_Widget::get_field_id() WordPress Method

The WP_Widget::get_field_id() method allows you to retrieve the HTML ID for a given field. This can be useful for targeting specific fields with CSS or JavaScript.

WP_Widget::get_field_id( string $field_name ) #

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().


Top ↑

Parameters

$field_name

(string)(Required)Field name.


Top ↑

Return

(string) ID attribute for $field_name.


Top ↑

Source

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

	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;
	}

Top ↑

Changelog

Changelog
VersionDescription
4.4.0Array format field IDs are now accepted.
2.8.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.