WP_Screen::get_option( string $option, string|false $key = false ): string

In this article

Gets the arguments for an option for the screen.

Parameters

$optionstringrequired
Option name.
$keystring|falseoptional
Specific array key for when the option is an array.

Default:false

Return

string The option value if set, null otherwise.

Source

public function get_option( $option, $key = false ) {
	if ( ! isset( $this->_options[ $option ] ) ) {
		return null;
	}
	if ( $key ) {
		if ( isset( $this->_options[ $option ][ $key ] ) ) {
			return $this->_options[ $option ][ $key ];
		}
		return null;
	}
	return $this->_options[ $option ];
}

Changelog

VersionDescription
3.3.0Introduced.

User Contributed Notes

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