Object_Sync_Sf_Admin_Notice
Object_Sync_Sf_Admin_Notice class.
Table of Contents
- $condition : bool
- The condition the notice is checking
- $dismissible : bool
- Whether the notice is dismisable or not
- $file : string
- The main plugin file
- $message : string
- The message that is being displayed
- $template : string
- Which template is used for display
- $type : string
- What type of notice it is
- __construct() : mixed
- Constructor for admin notice class
- render() : mixed
- Render an admin notice
Properties
$condition
The condition the notice is checking
public
bool
$condition
$dismissible
Whether the notice is dismisable or not
public
bool
$dismissible
$file
The main plugin file
public
string
$file
$message
The message that is being displayed
public
string
$message
$template
Which template is used for display
public
string
$template
$type
What type of notice it is
public
string
$type
Methods
__construct()
Constructor for admin notice class
public
__construct(bool $condition, string $message, bool $dismissible, string $type, string $template) : mixed
Parameters
- $condition : bool
-
whether the condition for the notice was met.
- $message : string
-
the message to show to the user.
- $dismissible : bool
-
whether the user can dismiss this message.
- $type : string
-
what type of message this is.
- $template : string
-
the template to render this message.
Return values
mixed —render()
Render an admin notice
public
render() : mixed