PHPXRef 0.7.1 : BuddyPress : Detail view of class-bp-members-invitation-manager.php

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.

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

run_acceptance_action( $type, $r ) X-Ref

This is where custom actions are added to run when an invitation
or request is accepted.

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

allow_invitation( $args ) X-Ref

Should this invitation be created?

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

allow_request( $args ) X-Ref

Should this request be created?

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

PHP Cross Reference of BuddyPress

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

Defines 1 class