BP_Members_Component

Defines the BuddyPress Members Component.

Description

Source

File: bp-members/classes/class-bp-members-component.php

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

class BP_Members_Component extends BP_Component {
 
    /**
     * Profile types.
     *
     * @see bp_register_member_type()
     *
     * @since BuddyPress 2.2.0
     * @var array
     */
    public $types = array();
 
    /**
     * Start the members component creation process.
     *
     * @since BuddyPress 1.5.0
     */
    public function __construct() {
        parent::start(
            'members',
            __( 'Members', 'buddyboss' ),
            buddypress()->plugin_dir,
            array(
                'adminbar_myaccount_order' => 10,
                'search_query_arg' => 'members_search',
            )
        );
    }
 
    /**
     * Include bp-members files.
     *
     * @since BuddyPress 1.5.0
     *
     * @see BP_Component::includes() for description of parameters.
     *
     * @param array $includes See {@link BP_Component::includes()}.
     */
    public function includes( $includes = array() ) {
 
        // Always include these files.
        $includes = array(
            'filters',
            'template',
            'adminbar',
            'functions',
            'widgets',
            'cache',
        );
 
        if ( bp_is_active( 'activity' ) ) {
            $includes[] = 'activity';
        }
 
        // Include these only if in admin.
        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;
        }
 
        // Members.
        if ( bp_is_members_component() ) {
            // Actions - Random member handler.
            if ( isset( $_GET['random-member'] ) ) {
                require $this->path . 'bp-members/actions/random.php';
            }
 
            // Screens - Directory.
            if ( bp_is_members_directory() ) {
                require $this->path . 'bp-members/screens/directory.php';
            }
        }
 
        // Members - User main nav screen.
        if ( bp_is_user() ) {
            require $this->path . 'bp-members/screens/profile.php';
        }
 
        // Members - Theme compatibility.
        if ( bp_is_members_component() || bp_is_user() ) {
            new BP_Members_Theme_Compat();
        }
 
        // Registration / Activation.
        if ( bp_is_register_page() || bp_is_activation_page() ) {
            if ( bp_is_register_page() ) {
                require $this->path . 'bp-members/screens/register.php';
            } else {
                require $this->path . 'bp-members/screens/activate.php';
            }
 
            // Theme compatibility.
            new BP_Registration_Theme_Compat();
        }
    }
 
    /**
     * Set up bp-members global settings.
     *
     * The BP_MEMBERS_SLUG constant is deprecated, and only used here for
     * backwards compatibility.
     *
     * @since BuddyPress 1.5.0
     *
     * @see BP_Component::setup_globals() for description of parameters.
     *
     * @param array $args See {@link BP_Component::setup_globals()}.
     */
    public function setup_globals( $args = array() ) {
        global $wpdb;
 
        $bp = buddypress();
 
        /** Component Globals ************************************************
         */
 
        // Define a slug, as a fallback for backpat.
        if ( !defined( 'BP_MEMBERS_SLUG' ) ) {
            define( 'BP_MEMBERS_SLUG', $this->id );
        }
 
        // Fetch the default directory title.
        $default_directory_titles = bp_core_get_directory_page_default_titles();
        $default_directory_title  = $default_directory_titles[$this->id];
 
        // Override any passed args.
        $args = array(
            'slug'            => BP_MEMBERS_SLUG,
            'root_slug'       => isset( $bp->pages->members->slug ) ? $bp->pages->members->slug : BP_MEMBERS_SLUG,
            'has_directory'   => true,
            'directory_title' => isset( $bp->pages->members->title ) ? $bp->pages->members->title : $default_directory_title,
            'search_string'   => __( 'Search Members&hellip;', 'buddyboss' ),
            'global_tables'   => array(
                'table_name_last_activity' => bp_core_get_table_prefix() . 'bp_activity',
                'table_name_signups'       => $wpdb->base_prefix . 'signups', // Signups is a global WordPress table.
            )
        );
 
        parent::setup_globals( $args );
 
        /** Logged in user ***************************************************
         */
 
        // The core userdata of the user who is currently logged in.
        $bp->loggedin_user->userdata       = bp_core_get_core_userdata( bp_loggedin_user_id() );
 
        // Fetch the full name for the logged in user.
        $bp->loggedin_user->fullname       = isset( $bp->loggedin_user->userdata->display_name ) ? $bp->loggedin_user->userdata->display_name : '';
 
        // Hits the DB on single WP installs so get this separately.
        $bp->loggedin_user->is_super_admin = $bp->loggedin_user->is_site_admin = is_super_admin( bp_loggedin_user_id() );
 
        // The domain for the user currently logged in. eg: http://example.com/members/andy.
        $bp->loggedin_user->domain         = bp_core_get_user_domain( bp_loggedin_user_id() );
 
        /** Displayed user ***************************************************
         */
 
        // The core userdata of the user who is currently being displayed.
        $bp->displayed_user->userdata = bp_core_get_core_userdata( bp_displayed_user_id() );
 
        // Fetch the full name displayed user.
        $bp->displayed_user->fullname = isset( $bp->displayed_user->userdata->display_name ) ? $bp->displayed_user->userdata->display_name : '';
 
        // The domain for the user currently being displayed.
        $bp->displayed_user->domain   = bp_core_get_user_domain( bp_displayed_user_id() );
 
        // Initialize the nav for the members component.
        $this->nav = new BP_Core_Nav();
 
        // If A user is displayed, check if there is a front template
        if ( bp_get_displayed_user() ) {
            $bp->displayed_user->front_template = bp_displayed_user_get_front_template();
        }
 
        /** Signup ***********************************************************
         */
 
        $bp->signup = new stdClass;
 
        /** Profiles Fallback ************************************************
         */
 
        if ( ! bp_is_active( 'xprofile' ) ) {
            $bp->profile       = new stdClass;
            $bp->profile->slug = 'profile';
            $bp->profile->id   = 'profile';
        }
    }
 
    /**
     * Set up canonical stack for this component.
     *
     * @since BuddyPress 2.1.0
     */
    public function setup_canonical_stack() {
        $bp = buddypress();
 
        /** Default Profile Component ****************************************
         */
        if ( bp_displayed_user_has_front_template() && bp_is_my_profile() ) {
            $bp->default_component = 'front';
        } elseif ( defined( 'BP_DEFAULT_COMPONENT' ) && BP_DEFAULT_COMPONENT ) {
            $bp->default_component = BP_DEFAULT_COMPONENT;
        } elseif ( bp_is_active( 'xprofile' ) ) {
            $bp->default_component = ( 'xprofile' === $bp->profile->id ) ? 'profile' : $bp->profile->id;
        } elseif ( bp_is_active( 'activity' ) && isset( $bp->pages->activity ) ) {
            $bp->default_component = bp_get_activity_slug();
        } else {
            $bp->default_component = ( 'xprofile' === $bp->profile->id ) ? 'profile' : $bp->profile->id;
        }
 
        // Get the default tab based on the customizer settings.
        $customizer_option = 'user_default_tab';
        $default_tab       = '';
 
        if ( function_exists( 'bp_nouveau_get_temporary_setting' ) && function_exists( 'bp_nouveau_get_appearance_settings' ) ) {
            $default_tab = bp_nouveau_get_temporary_setting( $customizer_option,bp_nouveau_get_appearance_settings( $customizer_option ) );
        }
        $default_tab = bp_is_active( $default_tab ) ? $default_tab : 'profile';
 
        $bp->default_component = apply_filters( 'bp_member_default_component', ( '' === $default_tab ) ? $bp->default_component : $default_tab );
 
 
        /** Canonical Component Stack ****************************************
         */
 
        if ( bp_displayed_user_id() ) {
            $bp->canonical_stack['base_url'] = bp_displayed_user_domain();
 
            if ( bp_current_component() ) {
                $bp->canonical_stack['component'] = bp_current_component();
            }
 
            if ( bp_current_action() ) {
                $bp->canonical_stack['action'] = bp_current_action();
            }
 
            if ( !empty( $bp->action_variables ) ) {
                $bp->canonical_stack['action_variables'] = bp_action_variables();
            }
 
            // Looking at the single member root/home, so assume the default.
            if ( ! bp_current_component() ) {
                $bp->current_component = $bp->default_component;
 
            // The canonical URL will not contain the default component.
            } elseif ( bp_is_current_component( $bp->default_component ) && ! bp_current_action() ) {
                unset( $bp->canonical_stack['component'] );
            }
 
            // If we're on a spammer's profile page, only users with the 'bp_moderate' cap
            // can view subpages on the spammer's profile.
            //
            // users without the cap trying to access a spammer's subnav page will get
            // redirected to the root of the spammer's profile page.  this occurs by
            // by removing the component in the canonical stack.
            if ( bp_is_user_spammer( bp_displayed_user_id() ) && ! bp_current_user_can( 'bp_moderate' ) ) {
                unset( $bp->canonical_stack['component'] );
            }
        }
    }
 
    /**
     * Set up fall-back component navigation if XProfile is inactive.
     *
     * @since BuddyPress 1.5.0
     *
     * @see BP_Component::setup_nav() for a description of arguments.
     *
     * @param array $main_nav Optional. See BP_Component::setup_nav() for
     *                        description.
     * @param array $sub_nav  Optional. See BP_Component::setup_nav() for
     *                        description.
     */
    public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
 
        // Don't set up navigation if there's no member.
        if ( ! is_user_logged_in() && ! bp_is_user() ) {
            return;
        }
 
        $is_xprofile_active = bp_is_active( 'xprofile' );
 
        // Bail if XProfile component is active and there's no custom front page for the user.
        if ( ! bp_displayed_user_has_front_template() && $is_xprofile_active ) {
            return;
        }
 
        // 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;
        }
 
        // Set slug to profile in case the xProfile component is not active
        $slug = bp_get_profile_slug();
 
        // Defaults to empty navs
        $this->main_nav = array();
        $this->sub_nav  = array();
 
        if ( ! $is_xprofile_active ) {
            $this->main_nav = array(
                'name'                => __( 'Profile', 'buddyboss' ),
                'slug'                => $slug,
                'position'            => 10,
                'screen_function'     => 'bp_members_screen_display_profile',
                'default_subnav_slug' => 'public',
                'item_css_id'         => buddypress()->profile->id
            );
        }
 
        /**
         * Setup the subnav items for the member profile.
         *
         * This is required in case there's a custom front or in case the xprofile component
         * is not active.
         */
        $this->sub_nav = array(
            'name'            => __( 'View', 'buddyboss' ),
            'slug'            => 'public',
            'parent_url'      => trailingslashit( $user_domain . $slug ),
            'parent_slug'     => $slug,
            'screen_function' => 'bp_members_screen_display_profile',
            'position'        => 10
        );
 
        /**
         * If there's a front template the members component nav
         * will be there to display the user's front page.
         */
        if ( bp_displayed_user_has_front_template() ) {
            $main_nav = array(
                'name'                => __( 'Dashboard', 'buddyboss' ),
                'slug'                => 'front',
                'position'            => 5,
                'screen_function'     => 'bp_members_screen_display_profile',
                'default_subnav_slug' => 'public',
            );
 
            // We need a dummy subnav for the front page to load.
            $front_subnav = $this->sub_nav;
            $front_subnav['parent_slug'] = 'front';
 
            // In case the subnav is displayed in the front template
            $front_subnav['parent_url'] = trailingslashit( $user_domain . 'front' );
 
            // Set the subnav
            $sub_nav[] = $front_subnav;
 
            /**
             * If the profile component is not active, we need to create a new
             * nav to display the WordPress profile.
             */
            if ( ! $is_xprofile_active ) {
                add_action( 'bp_members_setup_nav', array( $this, 'setup_profile_nav' ) );
            }
 
        /**
         * If there's no front template and xProfile is not active, the members
         * component nav will be there to display the WordPress profile
         */
        } else {
            $main_nav  = $this->main_nav;
            $sub_nav[] = $this->sub_nav;
        }
 
 
        parent::setup_nav( $main_nav, $sub_nav );
    }
 
    /**
     * Set up a profile nav in case the xProfile
     * component is not active and a front template is
     * used.
     *
     * @since BuddyPress 2.6.0
     */
    public function setup_profile_nav() {
        if ( empty( $this->main_nav ) || empty( $this->sub_nav ) ) {
            return;
        }
 
        // Add the main nav
        bp_core_new_nav_item( $this->main_nav, 'members' );
 
        // Add the sub nav item.
        bp_core_new_subnav_item( $this->sub_nav, 'members' );
    }
 
    /**
     * Set up the title for pages and <title>.
     *
     * @since BuddyPress 1.5.0
     */
    public function setup_title() {
        $bp = buddypress();
 
        if ( bp_is_my_profile() ) {
            $bp->bp_options_title = __( 'You', 'buddyboss' );
        } elseif ( bp_is_user() ) {
            $bp->bp_options_title  = bp_get_displayed_user_fullname();
            $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->bp_options_title )
            ) );
        }
 
        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_last_activity',
            'bp_member_type'
        ) );
 
        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 members component creation process.
includes — Include bp-members files.
late_includes — Late includes method.
rest_api_init — Init the BuddyBoss REST API.
setup_cache_groups — Setup cache groups.
setup_canonical_stack — Set up canonical stack for this component.
setup_globals — Set up bp-members global settings.
setup_nav — Set up fall-back component navigation if XProfile is inactive.
setup_profile_nav — Set up a profile nav in case the xProfile component is not active and a front template is used.
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