Class: \Conifer\Admin\Notice
Provides a high-level API for dislaying all sorts of WP Admin notices
Visibility | Function |
---|---|
public | __construct(\string $message, \string $extraClasses='' )</strong> : voidConstructor Multiple classes can be specified with a space-separated string, e.g. "one two three" |
public | add_class(\string $class)</strong> : \Conifer\Admin\Notice Add an HTML class to be rendered on this notice |
public static | clear_flash_notices() : void Clear all flash notices in session |
public static | disable_flash_notices() : void Disable flash notices |
public | display() : void Display the admin notice |
public static | display_flash_notices() : void Display any flash notices stored in session during the admin_notices hook |
public static | enable_flash_notices() : void Enable flash notices to be stored in the $_SESSION superglobal |
public | error() : void Display this notice as an error |
public | flash() : void Display this notice on the next page load |
public | flash_error() : void Display this notice as an error message on the next page load |
public | flash_info() : void Display this notice as an info message on the next page load |
public static | flash_notices_enabled() : bool Whether flash notices are enabled |
public | flash_success() : void Display this notice as a success message on the next page load |
public | flash_warning() : void Display this notice as a warning on the next page load |
public | get_class() : string e.g. "notice notice-error" Get the HTML class or classes to be rendered in the notice markup |
public static | get_flash_notices() : Notice[] an array of Notice instances Get the flash notices to be displayed based on session data |
public | has_class(\string $class)</strong> : bool Whether this Notice has the given $class |
public | has_style_class() : bool Whether this notice has a special style class that WordPress targets in its built-in admin styles. |
public | html() : string the HTML to be rendered Get the message <div> markup |
public | info() : void Display this notice as an info message |
public | success() : void Display this notice as a success message |
public | warning() : void Display this notice as a warning |
protected static | valid_session_notice(mixed $notice)</strong> : bool Validate a session notice array |