WordPress Developer Resources

WP_Screen::in_admin( string $admin = null ): bool

Indicates whether the screen is in a particular admin.

Parameters

$adminstringoptional: The admin to check against (network | user | site).
If empty any of the three admins will result in true.
Default:null

Return

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

Source

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

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

View all references View on Trac View on GitHub

Changelog

Version	Description
3.5.0	Introduced.

User Contributed Notes

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