[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

/src/bp-messages/classes/ -> class-bp-messages-notice.php (summary)

BuddyPress Messages Classes.

File Size: 310 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

BP_Messages_Notice:: (9 methods):
  __construct()
  populate()
  save()
  activate()
  deactivate()
  delete()
  get_notices()
  get_total_notice_count()
  get_active()


Class: BP_Messages_Notice  - X-Ref

BuddyPress Notices class.

Use this class to create, activate, deactivate or delete notices.

__construct( $id = null )   X-Ref
Constructor.

param: int|null $id Optional. The ID of the current notice.
since: 1.0.0

populate()   X-Ref
Populate method.

Runs during constructor.

since: 1.0.0

save()   X-Ref
Saves a notice.

return: bool
since: 1.0.0

activate()   X-Ref
Activates a notice.

return: bool
since: 1.0.0

deactivate()   X-Ref
Deactivates a notice.

return: bool
since: 1.0.0

delete()   X-Ref
Deletes a notice.

return: bool
since: 1.0.0

get_notices( $args = array()   X-Ref
Pulls up a list of notices.

To get all notices, pass a value of -1 to pag_num.

param: array $args {
return: object List of notices to display.
since: 1.0.0

get_total_notice_count()   X-Ref
Returns the total number of recorded notices.

return: int
since: 1.0.0

get_active()   X-Ref
Returns the active notice that should be displayed on the front end.

return: object The BP_Messages_Notice object.
since: 1.0.0



Generated: Mon Sep 16 01:01:39 2019 Cross-referenced by PHPXref 0.7.1