BP_Messages_Component

Implementation of BP_Component for the Messages component.
Description

Source

File: bp-messages/classes/class-bp-messages-component.php
class BP_Messages_Component extends BP_Component {
 
    /**
     * If this is true, the Message autocomplete will return friends only, unless
     * this is set to false, in which any matching users will be returned.
     *
     * @since BuddyPress 1.5.0
     * @var bool
     */
    public $autocomplete_all;
 
    /**
     * Start the messages component creation process.
     *
     * @since BuddyPress 1.5.0
     */
    public function __construct() {
        parent::start(
            'messages',
            __( 'Private Messages', 'buddyboss' ),
            buddypress()->plugin_dir,
            array(
                'adminbar_myaccount_order' => 50,
                'features'                 => array( 'star' )
            )
        );
    }
 
    /**
     * Include files.
     *
     * @since BuddyPress 1.5.0
     *
     * @param array $includes See {BP_Component::includes()} for details.
     */
    public function includes( $includes = array() ) {
 
        // Files to include.
        $includes = array(
            'cssjs',
            'cache',
            'filters',
            'template',
            'functions',
            'widgets',
        );
 
        // Conditional includes.
        if ( bp_is_active( 'notifications' ) ) {
            $includes[] = 'notifications';
        }
        if ( bp_is_active( $this->id, 'star' ) ) {
            $includes[] = 'star';
        }
        if ( is_admin() ) {
            $includes[] = 'admin';
        }
 
        parent::includes( $includes );
    }
 
    /**
     * Late includes method.
     *
     * Only load up certain code when on specific pages.
     *
     * @since BuddyPress 3.0.0
     */
    public function late_includes() {
        // Bail if PHPUnit is running.
        if ( defined( 'BP_TESTS_DIR' ) ) {
            return;
        }
 
        if ( bp_is_messages_component() ) {
            // Authenticated actions.
            if ( is_user_logged_in() &&
                in_array( bp_current_action(), array( 'compose', 'notices', 'view' ), true )
            ) {
                require $this->path . 'bp-messages/actions/' . bp_current_action() . '.php';
            }
 
            // Authenticated action variables.
            if ( is_user_logged_in() && bp_action_variable( 0 ) &&
                in_array( bp_action_variable( 0 ), array( 'delete', 'read', 'unread', 'bulk-manage', 'bulk-delete' ), true )
            ) {
                require $this->path . 'bp-messages/actions/' . bp_action_variable( 0 ) . '.php';
            }
 
            // Authenticated actions - Star.
            if ( is_user_logged_in() && bp_is_active( $this->id, 'star' ) ) {
                // Single action.
                if ( in_array( bp_current_action(), array( 'star', 'unstar' ), true ) ) {
                    require $this->path . 'bp-messages/actions/star.php';
                }
 
                // Bulk-manage.
                if ( bp_is_action_variable( 'bulk-manage' ) ) {
                    require $this->path . 'bp-messages/actions/bulk-manage-star.php';
                }
            }
 
            // Screens - User profile integration.
            if ( bp_is_user() ) {
                require $this->path . 'bp-messages/screens/inbox.php';
 
                /*
                 * Nav items.
                 *
                 * 'view' is not a registered nav item, but we add a screen handler manually.
                 */
                if ( bp_is_user_messages() && in_array( bp_current_action(), array( 'compose', 'notices', 'view' ), true ) ) {
                    require $this->path . 'bp-messages/screens/' . bp_current_action() . '.php';
                }
 
                // Nav item - Starred.
                if ( bp_is_active( $this->id, 'star' ) && bp_is_current_action( bp_get_messages_starred_slug() ) ) {
                    require $this->path . 'bp-messages/screens/starred.php';
                }
            }
        }
    }
 
    /**
     * Set up globals for the Messages component.
     *
     * The BP_MESSAGES_SLUG constant is deprecated, and only used here for
     * backwards compatibility.
     *
     * @since BuddyPress 1.5.0
     *
     * @param array $args Not used.
     */
    public function setup_globals( $args = array() ) {
        $bp = buddypress();
 
        // Define a slug, if necessary.
        if ( ! defined( 'BP_MESSAGES_SLUG' ) ) {
            define( 'BP_MESSAGES_SLUG', $this->id );
        }
 
        // Global tables for messaging component.
        $global_tables = array(
            'table_name_notices'    => $bp->table_prefix . 'bp_messages_notices',
            'table_name_messages'   => $bp->table_prefix . 'bp_messages_messages',
            'table_name_recipients' => $bp->table_prefix . 'bp_messages_recipients',
            'table_name_meta'       => $bp->table_prefix . 'bp_messages_meta',
        );
 
        // Metadata tables for messaging component.
        $meta_tables = array(
            'message' => $bp->table_prefix . 'bp_messages_meta',
        );
 
        $this->autocomplete_all = defined( 'BP_MESSAGES_AUTOCOMPLETE_ALL' );
 
        // All globals for messaging component.
        // Note that global_tables is included in this array.
        parent::setup_globals( array(
            'slug'                  => BP_MESSAGES_SLUG,
            'has_directory'         => false,
            'notification_callback' => 'messages_format_notifications',
            'search_string'         => __( 'Search Messages&hellip;', 'buddyboss' ),
            'global_tables'         => $global_tables,
            'meta_tables'           => $meta_tables
        ) );
    }
 
    /**
     * Set up navigation for user pages.
     *
     * @param array $main_nav See {BP_Component::setup_nav()} for details.
     * @param array $sub_nav  See {BP_Component::setup_nav()} for details.
     */
    public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
 
        // Determine user to use.
        if ( bp_displayed_user_domain() ) {
            $user_domain = bp_displayed_user_domain();
        } elseif ( bp_loggedin_user_domain() ) {
            $user_domain = bp_loggedin_user_domain();
        } else {
            return;
        }
 
        $access        = bp_core_can_edit_settings();
        $slug          = bp_get_messages_slug();
        $messages_link = trailingslashit( $user_domain . $slug );
 
        // Only grab count if we're on a user page and current user has access.
        if ( bp_is_user() && bp_user_has_access() ) {
            $count    = bp_get_total_unread_messages_count( bp_displayed_user_id() );
            $class    = ( 0 === $count ) ? 'no-count' : 'count';
            $nav_name = sprintf(
                /* translators: %s: Unread message count for the current user */
                __( 'Messages %s', 'buddyboss' ),
                sprintf(
                    '<span class="%s">%s</span>',
                    esc_attr( $class ),
                    bp_core_number_format( $count )
                )
            );
        } else {
            $nav_name = __( 'Messages', 'buddyboss' );
        }
 
        // Add 'Messages' to the main navigation.
        $main_nav = array(
            'name'                    => $nav_name,
            'slug'                    => $slug,
            'position'                => 50,
            'show_for_displayed_user' => $access,
            'screen_function'         => 'messages_screen_inbox',
            'default_subnav_slug'     => 'inbox',
            'item_css_id'             => $this->id
        );
 
        // Add the subnav items to the profile.
        $sub_nav[] = array(
            'name'            => __( 'Messages', 'buddyboss' ),
            'slug'            => 'inbox',
            'parent_url'      => $messages_link,
            'parent_slug'     => $slug,
            'screen_function' => 'messages_screen_inbox',
            'position'        => 10,
            'user_has_access' => $access
        );
 
        // Show certain screens only if the current user is the displayed user.
        if ( bp_is_my_profile() ) {
 
            // Show "Compose" on the logged-in user's profile only.
            $sub_nav[] = array(
                'name'            => __( 'New Message', 'buddyboss' ),
                'slug'            => 'compose',
                'parent_url'      => $messages_link,
                'parent_slug'     => $slug,
                'screen_function' => 'messages_screen_compose',
                'position'        => 30,
                'user_has_access' => $access
            );
 
            /*
             * Show "Notices" on the logged-in user's profile only
             * and then only if the user can create notices.
             */
            if ( bp_current_user_can( 'bp_moderate' ) ) {
                $sub_nav[] = array(
                    'name'            => __( 'Notices', 'buddyboss' ),
                    'slug'            => 'notices',
                    'parent_url'      => $messages_link,
                    'parent_slug'     => $slug,
                    'screen_function' => 'messages_screen_notices',
                    'position'        => 90,
                    'user_has_access' => true
                );
            }
        }
 
        parent::setup_nav( $main_nav, $sub_nav );
    }
 
    /**
     * Set up the Toolbar.
     *
     * @param array $wp_admin_nav See {BP_Component::setup_admin_bar()} for details.
     */
    public function setup_admin_bar( $wp_admin_nav = array() ) {
 
        // Menus for logged in user.
        if ( is_user_logged_in() ) {
 
            // Setup the logged in user variables.
            $messages_link = trailingslashit( bp_loggedin_user_domain() . bp_get_messages_slug() );
 
            // Unread message count.
            $count = messages_get_unread_count( bp_loggedin_user_id() );
            if ( !empty( $count ) ) {
                $title = sprintf(
                    /* translators: %s: Unread message count for the current user */
                    __( 'Messages %s', 'buddyboss' ),
                    '<span class="count">' . bp_core_number_format( $count ) . '</span>'
                );
                $inbox = sprintf(
                    /* translators: %s: Unread message count for the current user */
                    __( 'Messages %s', 'buddyboss' ),
                    '<span class="count">' . bp_core_number_format( $count ) . '</span>'
                );
            } else {
                $title = __( 'Messages', 'buddyboss' );
                $inbox = __( 'Messages',    'buddyboss' );
            }
 
            // Add main Messages menu.
            $wp_admin_nav[] = array(
                'parent' => buddypress()->my_account_menu_id,
                'id'     => 'my-account-' . $this->id,
                'title'  => $title,
                'href'   => $messages_link
            );
 
            // Inbox.
            $wp_admin_nav[] = array(
                'parent'   => 'my-account-' . $this->id,
                'id'       => 'my-account-' . $this->id . '-inbox',
                'title'    => $inbox,
                'href'     => $messages_link,
                'position' => 10
            );
 
            // Compose Message.
            $wp_admin_nav[] = array(
                'parent'   => 'my-account-' . $this->id,
                'id'       => 'my-account-' . $this->id . '-compose',
                'title'    => __( 'New Message', 'buddyboss' ),
                'href'     => trailingslashit( $messages_link . 'compose' ),
                'position' => 30
            );
 
            // Site Wide Notices.
            if ( bp_current_user_can( 'bp_moderate' ) ) {
                $wp_admin_nav[] = array(
                    'parent'   => 'my-account-' . $this->id,
                    'id'       => 'my-account-' . $this->id . '-notices',
                    'title'    => __( 'Site Notices', 'buddyboss' ),
                    'href'     => trailingslashit( $messages_link . 'notices' ),
                    'position' => 90
                );
            }
        }
 
        parent::setup_admin_bar( $wp_admin_nav );
    }
 
    /**
     * Set up the title for pages and <title>.
     */
    public function setup_title() {
 
        if ( bp_is_messages_component() ) {
            $bp = buddypress();
 
            if ( bp_is_my_profile() ) {
                $bp->bp_options_title = __( 'My Messages', 'buddyboss' );
            } else {
                $bp->bp_options_avatar = bp_core_fetch_avatar( array(
                    'item_id' => bp_displayed_user_id(),
                    'type'    => 'thumb',
                    'alt'     => sprintf( __( 'Profile photo of %s', 'buddyboss' ), bp_get_displayed_user_fullname() )
                ) );
                $bp->bp_options_title = bp_get_displayed_user_fullname();
            }
        }
 
        parent::setup_title();
    }
 
    /**
     * Setup cache groups
     *
     * @since BuddyPress 2.2.0
     */
    public function setup_cache_groups() {
 
        // Global groups.
        wp_cache_add_global_groups( array(
            'bp_messages',
            'bp_messages_threads',
            'bp_messages_unread_count',
            'message_meta'
        ) );
 
        parent::setup_cache_groups();
    }
}
Expand full source code Collapse full source code
Changelog

Changelog
Version	Description
BuddyPress 1.5.0	Introduced.
Uses

Uses
Uses	Description
bp-core/classes/class-bp-component.php: BP_Component	BuddyPress Component Class.
Methods

__construct — Start the messages component creation process.
includes — Include files.
late_includes — Late includes method.
rest_api_init — Init the BuddyBoss REST API.
setup_admin_bar — Set up the Toolbar.
setup_cache_groups — Setup cache groups
setup_globals — Set up globals for the Messages component.
setup_nav — Set up navigation for user pages.
setup_title — Set up the title for pages and .
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.
Contents
