WP_Screen::in_admin( string $admin = null )

Indicates whether the screen is in a particular admin

Parameters Parameters


(string) (Optional) The admin to check against (network | user | site). If empty any of the three admins will result in true.

Default value: null

Top ↑

Return Return

(bool) True if the screen is in the indicated admin, false otherwise.

Top ↑

Source Source

File: wp-admin/includes/class-wp-screen.php

	public function in_admin( $admin = null ) {
		if ( empty( $admin ) ) {
			return (bool) $this->in_admin;

		return ( $admin === $this->in_admin );

Top ↑

Changelog Changelog

Version Description
3.5.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

Top ↑

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