[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

/src/bp-members/classes/ -> class-bp-members-invitation-manager.php (summary)

[Source view] [Print] [Project Stats]

Membership invitations class.

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

Defines 1 class

BP_Members_Invitation_Manager:: (5 methods):
  __construct()
  run_send_action()
  run_acceptance_action()
  allow_invitation()
  allow_request()


Class: BP_Members_Invitation_Manager  - X-Ref

Membership invitations class.

An extension of the core Invitations class that adapts the
core logic to accommodate site membership invitation behavior.

__construct( $args = '' )   X-Ref
Construct parameters.

param: array|string $args.
since: 8.0.0

run_send_action( BP_Invitation $invitation )   X-Ref
This is where custom actions are added to run when notifications of an
invitation or request need to be generated & sent.

param: obj BP_Invitation $invitation The invitation to send.
since: 8.0.0
return: bool True on success, false on failure.

run_acceptance_action( $type, $r )   X-Ref
This is where custom actions are added to run when an invitation
or request is accepted.

param: string $type Are we accepting an invitation or request?
param: array  $r    Parameters that describe the invitation being accepted.
since: 8.0.0
return: bool True on success, false on failure.

allow_invitation( $args )   X-Ref
Should this invitation be created?

param: array $args.
since: 8.0.0
return: bool

allow_request( $args )   X-Ref
Should this request be created?

param: array $args.
since: 8.0.0
return: bool.


Generated: Sun Dec 22 01:00:54 2024 Cross-referenced by PHPXref 0.7.1