disabled() WordPress Function

The disabled() Wordpress function is used to disable a form field. This is useful for fields that are not needed for a particular form submission. For example, if a field is only needed for certain circumstances, it can be disabled when those circumstances are not present.

disabled( mixed $disabled, mixed $current = true, bool $echo = true ) #

Outputs the HTML disabled attribute.


Description

Compares the first two arguments and if identical marks as disabled.


Top ↑

Parameters

$disabled

(mixed)(Required)One of the values to compare.

$current

(mixed)(Optional) The other value to compare if not just true.

Default value: true

$echo

(bool)(Optional) Whether to echo or just return the string.

Default value: true


Top ↑

Return

(string) HTML attribute or empty string.


Top ↑

Source

File: wp-includes/general-template.php

function disabled( $disabled, $current = true, $echo = true ) {
	return __checked_selected_helper( $disabled, $current, $echo, 'disabled' );
}


Top ↑

Changelog

Changelog
VersionDescription
3.0.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.

Show More
Show More