Source Code Documentation


Field Summary | Method Summary | Field Detail | Method Detail

Package s2Member\Admin_Notices

s2member\includes\classes\admin-notices.inc.php at line #28

Class c_ws_plugin__s2member_admin_notices

c_ws_plugin__s2member_admin_notices

public class c_ws_plugin__s2member_admin_notices

Enqueues/displays administrative notices.

Since:

3.5


( 3 Methods )
Method Summary
public static null

admin_notices()

Processes all administrative notices.

public static null

display_admin_notice(str $notice, bool $error, bool $dismiss)

Displays an administrative notice.

public static null

enqueue_admin_notice(str $notice, str|array $on_pages, bool $error, int $time, bool $dismiss)

Enqueues administrative notices.

( 3 Methods )
Method Detail

s2member\includes\classes\admin-notices.inc.php at line #111

admin_notices()

public static null admin_notices()

Processes all administrative notices.

Since:

3.5

Attaches-to:

add_action("admin_notices");

add_action("user_admin_notices");

add_action("network_admin_notices");

Todo:

Update to add_action("all_admin_notices");.

Returns:

null

[ back to top ]

s2member\includes\classes\admin-notices.inc.php at line #76

display_admin_notice()

public static null display_admin_notice(str $notice, bool $error, bool $dismiss)

Displays an administrative notice.

Since:

3.5

Parameters:

str $notice - String value of actual notice (i.e. the message).

bool $error - Optional. True if this notice is regarding an error. Defaults to false.

bool $dismiss - Optional. If true, the notice will be displayed with a dismissal link. Defaults to false.

Returns:

null

[ back to top ]

s2member\includes\classes\admin-notices.inc.php at line #43

enqueue_admin_notice()

public static null enqueue_admin_notice(str $notice, str|array $on_pages, bool $error, int $time, bool $dismiss)

Enqueues administrative notices.

Since:

3.5

Parameters:

str $notice - String value of actual notice (i.e. the message).

str|array $on_pages - Optional. Defaults to any page. String or array of pages to display this notice on.

bool $error - Optional. True if this notice is regarding an error. Defaults to false.

int $time - Optional. Unix timestamp indicating when this notice will be displayed.

bool $dismiss - Optional. If true, the notice will remain persistent, until dismissed. Defaults to false.

Returns:

null

[ back to top ]

Source Code Documentation


Field Summary | Method Summary | Field Detail | Method Detail