Changeset 12960

Timestamp:

06/05/2021 03:42:50 AM (4 years ago)

Author:

imath

Message:

Members Invitations: Improve inline documentation about 3 functions

See #8480

File:

• trunk/src/bp-members/bp-members-invitations.php (modified) (4 diffs)

trunk/src/bp-members/bp-members-invitations.php

@@ -11 +11 @@
 defined( 'ABSPATH' ) || exit;
 
+/**
+ * Set up the displayed user's Members Invitations nav.
+ *
+ * @since 8.0.0
+ */
 function bp_members_invitations_setup_nav() {
     if ( ! bp_get_members_invitations_allowed() ) {
@@ -63 +68 @@
  * When a user joins the network via an invitation, skip sending the activation email.
  *
+ * @since 8.0.0
+ *
  * @param bool   $send           Whether or not to send the activation key.
  * @param int    $user_id        User ID to send activation key to.
@@ -69 +76 @@
  * @param array  $usermeta       Miscellaneous metadata about the user (blog-specific
  *                               signup data, xprofile data, etc).
+ * @return bool Whether or not to send the activation key.
  */
 function bp_members_invitations_cancel_activation_email( $send, $user_id, $user_email, $activation_key, $usermeta ) {
@@ -90 +98 @@
  * - mark all invitations and requests as accepted
  * - activate the user upon signup
+ *
+ * @since 8.0.0
  *
  * @param bool|WP_Error   $user_id       True on success, WP_Error on failure.