BP_Nouveau_Customizer_Group_Nav

A specific Group Nav class to make it possible to set new positions for buddypress()->groups->nav.
Description

Source

File: bp-templates/bp-nouveau/includes/groups/classes.php
class BP_Nouveau_Customizer_Group_Nav extends BP_Core_Nav {
    /**
     * Constructor
     *
     * @param int $object_id Optional. The random group ID used to generate the nav.
     */
    public function __construct( $object_id = 0 ) {
        $error = new WP_Error( 'missing_parameter' );
 
        if ( empty( $object_id ) || ! bp_current_user_can( 'bp_moderate' ) || ! did_action( 'admin_init' ) ) {
            return $error;
        }
 
        $group = groups_get_group( array( 'group_id' => $object_id ) );
        if ( empty( $group->id ) ) {
            return $error;
        }
 
        $this->group = $group;
 
        parent::__construct( $group->id );
        $this->setup_nav();
    }
 
    /**
     * Checks whether a property is set.
     *
     * Overrides BP_Core_Nav::__isset() to avoid looking into its nav property.
     *
     * @since BuddyPress 3.0.0
     *
     * @param string $key The property.
     *
     * @return bool True if the property is set, false otherwise.
     */
    public function __isset( $key ) {
        return isset( $this->{$key} );
    }
 
    /**
     * Gets a property.
     *
     * Overrides BP_Core_Nav::__isset() to avoid looking into its nav property.
     *
     * @since BuddyPress 3.0.0
     *
     * @param string $key The property.
     *
     * @return mixed The value corresponding to the property.
     */
    public function __get( $key ) {
        if ( ! isset( $this->{$key} ) ) {
            $this->{$key} = null;
        }
 
        return $this->{$key};
    }
 
    /**
     * Sets a property.
     *
     * Overrides BP_Core_Nav::__isset() to avoid adding a value to its nav property.
     *
     * @since BuddyPress 3.0.0
     *
     * @param string $key The property.
     *
     * @param mixed $value The value of the property.
     */
    public function __set( $key, $value ) {
        $this->{$key} = $value;
    }
 
    /**
     * Setup a temporary nav with only the needed parameters.
     *
     * @since BuddyPress 3.0.0
     */
    protected function setup_nav() {
        $nav_items = array(
            'root'    => array(
                'name'                => __( 'My Groups', 'buddyboss' ),
                'slug'                => $this->group->slug,
                'position'            => -1,
                /** This filter is documented in bp-groups/classes/class-bp-groups-component.php. */
                'default_subnav_slug' => apply_filters( 'bp_groups_default_extension', defined( 'BP_GROUPS_DEFAULT_EXTENSION' ) ? BP_GROUPS_DEFAULT_EXTENSION : 'home' ),
            ),
            'members'    => array(
                'name'        => __( 'Members', 'buddyboss' ),
                'slug'        => 'members',
                'parent_slug' => $this->group->slug,
                'position'    => 10,
            ),
            'invites' => array(
                'name'        => __( 'Send Invites', 'buddyboss' ),
                'slug'        => 'send-invites',
                'parent_slug' => $this->group->slug,
                'position'    => 70,
            ),
            'manage'  => array(
                'name'        => __( 'Manage', 'buddyboss' ),
                'slug'        => 'admin',
                'parent_slug' => $this->group->slug,
                'position'    => 1000,
            ),
        );
 
        if ( bp_is_active( 'forums' ) && function_exists( 'bbp_is_group_forums_active' ) ) {
            if ( bbp_is_group_forums_active() ) {
                $nav_items['forum'] = array(
                    'name'        => __( 'Discussions', 'buddyboss' ),
                    'slug'        => get_option( '_bbp_forum_slug', 'forum' ),
                    'parent_slug' => $this->group->slug,
                    'position'    => 30,
                );
            }
        }
 
        if ( bp_enable_group_hierarchies() ) {
            $nav_items['subgroups'] = array(
                'name'        => __( 'Subgroups', 'buddyboss' ),
                'slug'        => 'subgroups',
                'parent_slug' => $this->group->slug,
                'position'    => 30,
            );
        }
 
        if ( function_exists( 'bp_ld_sync' ) ) {
            $va = bp_ld_sync( 'settings' )->get( 'buddypress.enabled', true );
            if ( '1' === $va ) {
                $nav_items['courses'] = array(
                    'name'        => __( 'Courses', 'buddyboss' ),
                    'slug'        => 'courses',
                    'parent_slug' => $this->group->slug,
                    'position'    => 40,
                );
            }
        }
 
        if ( function_exists( 'bp_ld_sync' ) ) {
            $va = bp_ld_sync( 'settings' )->get( 'reports.enabled', true );
            if ( '1' === $va ) {
                $nav_items['reports'] = array(
                    'name'        => __( 'Reports', 'buddyboss' ),
                    'slug'        => 'reports',
                    'parent_slug' => $this->group->slug,
                    'position'    => 40,
                );
            }
        }
 
        if ( bp_is_active( 'activity' ) ) {
            $nav_items['activity'] = array(
                'name'        => __( 'Feed', 'buddyboss' ),
                'slug'        => 'activity',
                'parent_slug' => $this->group->slug,
                'position'    => 20,
            );
        }
 
        // Required params
        $required_params = array(
            'slug'              => true,
            'name'              => true,
            'nav_item_position' => true,
        );
 
        // Now find nav items plugins are creating within their Group extensions!
        foreach ( get_declared_classes() as $class ) {
            if ( is_subclass_of( $class, 'BP_Group_Extension' ) ) {
                $extension = new $class;
 
                if ( ! empty( $extension->params ) && ! array_diff_key( $required_params, $extension->params ) ) {
                    $nav_items[ $extension->params['slug'] ] = array(
                        'name'        => $extension->params['name'],
                        'slug'        => $extension->params['slug'],
                        'parent_slug' => $this->group->slug,
                        'position'    => $extension->params['nav_item_position'],
                    );
                }
            }
        }
 
        // Now we got all, create the temporary nav.
        foreach ( $nav_items as $nav_item ) {
            $this->add_nav( $nav_item );
        }
    }
 
    /**
     * Front template: do not look into group's template hierarchy.
     *
     * @since BuddyPress 3.0.0
     *
     * @param array $templates The list of possible group front templates.
     *
     * @return array The list of "global" group front templates.
     */
    public function all_groups_fronts( $templates = array() ) {
        return array_intersect( array(
            'groups/single/front.php',
            'groups/single/default-front.php',
        ), $templates );
    }
 
    /**
     * Get the original order for the group navigation.
     *
     * @since BuddyPress 3.0.0
     *
     * @return array a list of nav items slugs ordered.
     */
    public function get_default_value() {
        $default_nav = $this->get_secondary( array( 'parent_slug' => $this->group->slug ) );
        return wp_list_pluck( $default_nav, 'slug' );
    }
 
    /**
     * Get the list of nav items ordered according to the Site owner preferences.
     *
     * @since BuddyPress 3.0.0
     *
     * @return array the nav items ordered.
     */
    public function get_group_nav() {
        // Eventually reset the order
        bp_nouveau_set_nav_item_order( $this, bp_nouveau_get_appearance_settings( 'group_nav_order' ), $this->group->slug );
 
        return $this->get_secondary( array( 'parent_slug' => $this->group->slug ) );
    }
}
Expand full source code Collapse full source code
Changelog

Changelog
Version	Description
BuddyPress 3.0.0	Introduced.
Uses

Uses
Uses	Description
bp-core/classes/class-bp-core-nav.php: BP_Core_Nav	BuddyPress Nav.
Methods

__construct — Constructor
__get — Gets a property.
__isset — Checks whether a property is set.
__set — Sets a property.
all_groups_fronts — Front template: do not look into group's template hierarchy.
get_default_value — Get the original order for the group navigation.
get_group_nav — Get the list of nav items ordered according to the Site owner preferences.
setup_nav — Setup a temporary nav with only the needed parameters.
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
