Contents

Code Reference Classes BP_Admin_Setting_Friends

BP_Admin_Setting_Friends

Main Connection settings class.

Description

Source

File: bp-core/admin/settings/bp-admin-setting-friends.php

18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
class BP_Admin_Setting_Friends extends BP_Admin_Setting_tab {
 
    public function initialize() {
        $this->tab_label = __( 'Connections', 'buddyboss' );
        $this->tab_name  = 'bp-friends';
        $this->tab_order = 60;
    }
 
    public function is_active() {
        return bp_is_active( 'friends' );
    }
 
    public function register_fields() {
        $this->add_section( 'bp_friends', __( 'Connection Settings', 'buddyboss' ) );
 
        if ( bp_is_active( 'messages' ) ) {
            $this->add_field( 'bp-force-friendship-to-message', __( 'Messaging', 'buddyboss' ), [$this, 'bp_admin_setting_callback_force_friendship_to_message'], [$this, 'bp_admin_sanitize_callback_force_friendship_to_message'] );
        }
 
        // Connection Settings tutorial
        $this->add_field( 'bp-connection-settings-tutorial','', [$this, 'bp_connection_settings_tutorial'] );
    }
 
    /**
     * Force users to be connected before sending a message to each other.
     *
     * @since BuddyBoss 1.0.0
     */
    public function bp_admin_setting_callback_force_friendship_to_message() {
    ?>
        <input id="bp-force-friendship-to-message" name="bp-force-friendship-to-message" type="checkbox" value="1" <?php checked( bp_force_friendship_to_message( false ) ); ?> />
        <label for="bp-force-friendship-to-message"><?php _e( 'Require users to be connected before they can message each other', 'buddyboss' ); ?></label>
    <?php
    }
 
    /**
     * Sanitization for bp-force-friendship-to-message setting.
     *
     * In the UI, a checkbox asks whether you'd like to *enable* forceing users to be friends for messaging. For
     * legacy reasons, the option that we store is 1 if these friends or messaging is *disabled*. So we use this
     * function to flip the boolean before saving the intval.
     *
     * @since BuddyBoss 1.0.0
     *
     * @param bool $value Whether or not to sanitize.
     * @return bool
     */
    public function bp_admin_sanitize_callback_force_friendship_to_message( $value = false ) {
        return $value ? 1 : 0;
    }
 
    /**
     * Link to Connection Settings tutorial
     *
     * @since BuddyBoss 1.0.0
     *
     */
    function bp_connection_settings_tutorial() {
        ?>
 
        <p>
            <a class="button" href="<?php echo bp_core_help_docs_link( 'components/connections/connection-settings.md' ); ?>"><?php _e( 'View Tutorial', 'buddyboss' ); ?></a>
        </p>
 
        <?php
    }
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyBoss 1.0.0 Introduced.

Methods

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.