Contents

Code Reference Classes BP_Invitation BP_Invitation::update()

BP_Invitation::update( array $update_args = array(), array $where_args = array() )

Update invitations.

Description

See also

Parameters

$update_args

(Optional) Associative array of fields to update, and the values to update them to. Of the format array( 'user_id' => 4, 'class' => 'BP_Groups_Invitation_Manager', ).

Default value: array()

$where_args

(Optional) Associative array of columns/values, to determine which rows should be updated. Of the format array( 'item_id' => 7, 'class' => 'BP_Groups_Invitation_Manager', ).

Default value: array()

Return

(int|bool) Number of rows updated on success, false on failure.

Source

File: bp-core/classes/class-bp-invitation.php

860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
public static function update( $update_args = array(), $where_args = array() ) {
    $update = self::get_query_clauses( $update_args );
    $where  = self::get_query_clauses( $where_args  );
 
    /**
     * Fires before an invitation is updated.
     *
     * @since BuddyBoss 1.3.5
 
     *
     * @param array $where_args  Associative array of columns/values describing
     *                           invitations about to be deleted.
     * @param array $update_args Array of new values.
     */
    do_action( 'bp_invitation_before_update', $where_args, $update_args );
 
    $retval = self::_update( $update['data'], $where['data'], $update['format'], $where['format'] );
 
    // Clear matching items from the cache.
    $cache_args = $where_args;
    $cache_args['fields'] = 'ids';
    $maybe_cached_ids = self::get( $cache_args );
    foreach ( $maybe_cached_ids as $invite_id ) {
        wp_cache_delete( $invite_id, 'bp_invitations' );
    }
 
    /**
     * Fires after an invitation is updated.
     *
     * @since BuddyBoss 1.3.5
     *
     * @param array $where_args  Associative array of columns/values describing
     *                           invitations about to be deleted.
     * @param array $update_args Array of new values.
     */
    do_action( 'bp_invitation_after_update', $where_args, $update_args );
 
    return $retval;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyBoss 1.3.5 Introduced.

Uses

Uses
Uses Description
bp-core/classes/class-bp-invitation.php: BP_Invitation::get_query_clauses()

Assemble query clauses, based on arguments, to pass to $wpdb methods.
bp-core/classes/class-bp-invitation.php: BP_Invitation::_update()

Update invitations.
bp-core/classes/class-bp-invitation.php: BP_Invitation::get()

Get invitations, based on provided filter parameters.
bp-core/classes/class-bp-invitation.php: bp_invitation_before_update

Fires before an invitation is updated.
bp-core/classes/class-bp-invitation.php: bp_invitation_after_update

Fires after an invitation is updated.
Used By
Used By Description
bp-core/classes/class-bp-invitation-manager.php: BP_Invitation_Manager::update_invitation()

Update invitation, based on provided filter parameters.
bp-core/classes/class-bp-invitation.php: BP_Invitation::mark_sent()

Mark specific invitations as sent by invitation ID.
bp-core/classes/class-bp-invitation.php: BP_Invitation::mark_sent_by_data()

Mark invitations as sent that are found by user_id, inviter_id, item id, and optional secondary item id, and class name.
bp-core/classes/class-bp-invitation.php: BP_Invitation::mark_accepted()

Mark specific invitations as accepted by invitation ID.
bp-core/classes/class-bp-invitation.php: BP_Invitation::mark_accepted_by_data()

Mark invitations as accepted that are found by user_id, inviter_id, item id, and optional secondary item id, and class name.

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.