bp_activity_admin_load()

Set up the Activity admin page.

Description

Does the following:

  • Register contextual help and screen options for this admin page.
  • Enqueues scripts and styles.
  • Catches POST and GET requests related to Activity.

Source

File: bp-activity/bp-activity-admin.php

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
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
function bp_activity_admin_load() {
    global $bp_activity_list_table;
 
    $bp       = buddypress();
    $doaction = bp_admin_list_table_current_bulk_action();
    $min      = bp_core_get_minified_asset_suffix();
 
    /**
     * Fires at top of Activity admin page.
     *
     * @since BuddyPress 1.6.0
     *
     * @param string $doaction Current $_GET action being performed in admin screen.
     */
    do_action( 'bp_activity_admin_load', $doaction );
 
    // Edit screen.
    if ( 'edit' == $doaction && ! empty( $_GET['aid'] ) ) {
        // Columns screen option.
        add_screen_option( 'layout_columns', array( 'default' => 2, 'max' => 2, ) );
 
        get_current_screen()->add_help_tab( array(
            'id'      => 'bp-activity-edit-overview',
            'title'   => __( 'Overview', 'buddyboss' ),
            'content' =>
                '<p>' . __( 'You edit activities made on your site similar to the way you edit a comment. This is useful if you need to change which page the activity links to, or when you notice that the author has made a typographical error.', 'buddyboss' ) . '</p>' .
                '<p>' . __( 'The two big editing areas for the activity title and content are fixed in place, but you can reposition all the other boxes using drag and drop, and can minimize or expand them by clicking the title bar of each box. Use the Screen Options tab to unhide more boxes (Primary Item/Secondary Item, Link, Type, Author ID) or to choose a 1- or 2-column layout for this screen.', 'buddyboss' ) . '</p>' .
                '<p>' . __( 'You can also moderate the activity from this screen using the Status box, where you can also change the timestamp of the activity.', 'buddyboss' ) . '</p>'
        ) );
 
        get_current_screen()->add_help_tab( array(
            'id'      => 'bp-activity-edit-advanced',
            'title'   => __( 'Item, Link, Type', 'buddyboss' ),
            'content' =>
                '<p>' . __( '<strong>Primary Item/Secondary Item</strong> - These identify the object that created the activity. For example, the fields could reference a comment left on a specific site. Some types of activity may only use one, or none, of these fields.', 'buddyboss' ) . '</p>' .
                '<p>' . __( '<strong>Link</strong> - Used by some types of activity (blog posts and comments) to store a link back to the original content.', 'buddyboss' ) . '</p>' .
                '<p>' . __( '<strong>Type</strong> - Each distinct kind of activity has its own type. For example, <code>created_group</code> is used when a group is created and <code>joined_group</code> is used when a user joins a group.', 'buddyboss' ) . '</p>'
        ) );
 
        // Help panel - sidebar links.
        get_current_screen()->set_help_sidebar(
            '<p><strong>' . __( 'For more information:', 'buddyboss' ) . '</strong></p>' .
            '<p>' . __( '<a href="https://www.buddyboss.com/resources/">Documentation</a>', 'buddyboss' ) . '</p>'
        );
 
        // Register metaboxes for the edit screen.
        add_meta_box( 'submitdiv',           __( 'Status', 'buddyboss' ), 'bp_activity_admin_edit_metabox_status', get_current_screen()->id, 'side', 'core' );
        add_meta_box( 'bp_activity_itemids', __( 'Primary Item/Secondary Item', 'buddyboss' ), 'bp_activity_admin_edit_metabox_itemids', get_current_screen()->id, 'normal', 'core' );
        add_meta_box( 'bp_activity_link',    __( 'Link', 'buddyboss' ), 'bp_activity_admin_edit_metabox_link', get_current_screen()->id, 'normal', 'core' );
        add_meta_box( 'bp_activity_type',    __( 'Type', 'buddyboss' ), 'bp_activity_admin_edit_metabox_type', get_current_screen()->id, 'normal', 'core' );
        add_meta_box( 'bp_activity_userid',  __( 'Author ID', 'buddyboss' ), 'bp_activity_admin_edit_metabox_userid', get_current_screen()->id, 'normal', 'core' );
 
        /**
         * Fires after the registration of all of the default activity meta boxes.
         *
         * @since BuddyPress 2.4.0
         */
        do_action( 'bp_activity_admin_meta_boxes' );
 
        // Enqueue JavaScript files.
        wp_enqueue_script( 'postbox' );
        wp_enqueue_script( 'dashboard' );
        wp_enqueue_script( 'comment' );
 
    // Index screen.
    } else {
        // Create the Activity screen list table.
        $bp_activity_list_table = new BP_Activity_List_Table();
 
        // The per_page screen option.
        add_screen_option( 'per_page', array( 'label' => __( 'Activity', 'buddyboss' )) );
 
        // Help panel - overview text.
        get_current_screen()->add_help_tab( array(
            'id'      => 'bp-activity-overview',
            'title'   => __( 'Overview', 'buddyboss' ),
            'content' =>
                '<p>' . __( 'You can manage activities made on your site similar to the way you manage comments and other content. This screen is customizable in the same ways as other management screens, and you can act on activities using the on-hover action links or the Bulk Actions.', 'buddyboss' ) . '</p>' .
                '<p>' . __( 'There are many different types of activities. Some are generated automatically by BuddyBoss Platform and other plugins, and some are entered directly by a user in the form of status update. To help manage the different activity types, use the filter dropdown box to switch between them.', 'buddyboss' ) . '</p>'
        ) );
 
        // Help panel - moderation text.
        get_current_screen()->add_help_tab( array(
            'id'        => 'bp-activity-moderating',
            'title'     => __( 'Moderating Activity', 'buddyboss' ),
            'content'   =>
                '<p>' . __( 'In the <strong>Activity</strong> column, above each activity it says "Submitted on" followed by the date and time the activity item was generated on your site. Clicking on the date/time link will take you to that activity on your live site. Hovering over any activity gives you options to reply, edit, spam mark, or delete that activity.', 'buddyboss' ) . '</p>' .
                '<p>' . __( "In the <strong>In Response To</strong> column, if the activity was in reply to another activity, it shows that activity's author's picture and name, and a link to that activity on your live site. If there is a small bubble, the number in it shows how many other activities are related to this one; these are usually comments. Clicking the bubble will filter the activity screen to show only related activity items.", 'buddyboss' ) . '</p>'
        ) );
 
        // Help panel - sidebar links.
        get_current_screen()->set_help_sidebar(
            '<p><strong>' . __( 'For more information:', 'buddyboss' ) . '</strong></p>' .
            '<p>' . __( '<a href="https://www.buddyboss.com/resources/">Documentation</a>', 'buddyboss' ) . '</p>'
        );
 
        // Add accessible hidden heading and text for Activity screen pagination.
        get_current_screen()->set_screen_reader_content( array(
            /* translators: accessibility text */
            'heading_pagination' => __( 'Activity list navigation', 'buddyboss' ),
        ) );
 
    }
 
    // Enqueue CSS and JavaScript.
    wp_enqueue_script( 'bp_activity_admin_js', $bp->plugin_url . "bp-activity/admin/js/admin{$min}.js",   array( 'jquery', 'wp-ajax-response' ), bp_get_version(), true );
    wp_localize_script( 'bp_activity_admin_js', 'bp_activity_admin_vars', array(
        'page' => get_current_screen()->id
    ) );
    wp_enqueue_style( 'bp_activity_admin_css', $bp->plugin_url . "bp-activity/admin/css/admin{$min}.css", array(),                               bp_get_version()       );
 
    wp_style_add_data( 'bp_activity_admin_css', 'rtl', true );
    if ( $min ) {
        wp_style_add_data( 'bp_activity_admin_css', 'suffix', $min );
    }
 
    /**
     * Fires after the activity js and style has been enqueued.
     *
     * @since BuddyPress 2.4.0
     */
    do_action( 'bp_activity_admin_enqueue_scripts' );
 
    // Handle spam/un-spam/delete of activities.
    if ( !empty( $doaction ) && ! in_array( $doaction, array( '-1', 'edit', 'save', ) ) ) {
 
        // Build redirection URL.
        $redirect_to = remove_query_arg( array( 'aid', 'deleted', 'error', 'spammed', 'unspammed', ), wp_get_referer() );
        $redirect_to = add_query_arg( 'paged', $bp_activity_list_table->get_pagenum(), $redirect_to );
 
        // Get activity IDs.
        $activity_ids = array_map( 'absint', (array) $_REQUEST['aid'] );
 
        /**
         * Filters list of IDs being spammed/un-spammed/deleted.
         *
         * @since BuddyPress 1.6.0
         *
         * @param array $activity_ids Activity IDs to spam/un-spam/delete.
         */
        $activity_ids = apply_filters( 'bp_activity_admin_action_activity_ids', $activity_ids );
 
        // Is this a bulk request?
        if ( 'bulk_' == substr( $doaction, 0, 5 ) && ! empty( $_REQUEST['aid'] ) ) {
            // Check this is a valid form submission.
            check_admin_referer( 'bulk-activities' );
 
            // Trim 'bulk_' off the action name to avoid duplicating a ton of code.
            $doaction = substr( $doaction, 5 );
 
        // This is a request to delete, spam, or un-spam, a single item.
        } elseif ( !empty( $_REQUEST['aid'] ) ) {
 
            // Check this is a valid form submission.
            check_admin_referer( 'spam-activity_' . $activity_ids[0] );
        }
 
        // Initialise counters for how many of each type of item we perform an action on.
        $deleted = $spammed = $unspammed = 0;
 
        // Store any errors that occurs when updating the database items.
        $errors = array();
 
        // "We'd like to shoot the monster, could you move, please?"
        foreach ( $activity_ids as $activity_id ) {
            // @todo: Check the permissions on each
            // if ( ! current_user_can( 'bp_edit_activity', $activity_id ) )
            // continue;
            // Get the activity from the database.
            $activity = new BP_Activity_Activity( $activity_id );
            if ( empty( $activity->component ) ) {
                $errors[] = $activity_id;
                continue;
            }
 
            switch ( $doaction ) {
                case 'delete' :
                    if ( 'activity_comment' == $activity->type )
                        bp_activity_delete_comment( $activity->item_id, $activity->id );
                    else
                        bp_activity_delete( array( 'id' => $activity->id ) );
 
                    $deleted++;
                    break;
 
                case 'ham' :
                    /**
                     * Remove moderation and blacklist checks in case we want to ham an activity
                     * which contains one of these listed keys.
                     */
                    remove_action( 'bp_activity_before_save', 'bp_activity_check_moderation_keys', 2 );
                    remove_action( 'bp_activity_before_save', 'bp_activity_check_blacklist_keys', 2 );
 
                    bp_activity_mark_as_ham( $activity );
                    $result = $activity->save();
 
                    // Check for any error during activity save.
                    if ( ! $result )
                        $errors[] = $activity->id;
                    else
                        $unspammed++;
                    break;
 
                case 'spam' :
                    bp_activity_mark_as_spam( $activity );
                    $result = $activity->save();
 
                    // Check for any error during activity save.
                    if ( ! $result )
                        $errors[] = $activity->id;
                    else
                        $spammed++;
                    break;
 
                default:
                    break;
            }
 
            // Release memory.
            unset( $activity );
        }
 
        /**
         * Fires before redirect for plugins to do something with activity.
         *
         * Passes an activity array counts how many were spam, not spam, deleted, and IDs that were errors.
         *
         * @since BuddyPress 1.6.0
         *
         * @param array  $value        Array holding spam, not spam, deleted counts, error IDs.
         * @param string $redirect_to  URL to redirect to.
         * @param array  $activity_ids Original array of activity IDs.
         */
        do_action( 'bp_activity_admin_action_after', array( $spammed, $unspammed, $deleted, $errors ), $redirect_to, $activity_ids );
 
        // Add arguments to the redirect URL so that on page reload, we can easily display what we've just done.
        if ( $spammed )
            $redirect_to = add_query_arg( 'spammed', $spammed, $redirect_to );
 
        if ( $unspammed )
            $redirect_to = add_query_arg( 'unspammed', $unspammed, $redirect_to );
 
        if ( $deleted )
            $redirect_to = add_query_arg( 'deleted', $deleted, $redirect_to );
 
        // If an error occurred, pass back the activity ID that failed.
        if ( ! empty( $errors ) )
            $redirect_to = add_query_arg( 'error', implode ( ',', array_map( 'absint', $errors ) ), $redirect_to );
 
        /**
         * Filters redirect URL after activity spamming/un-spamming/deletion occurs.
         *
         * @since BuddyPress 1.6.0
         *
         * @param string $redirect_to URL to redirect to.
         */
        wp_redirect( apply_filters( 'bp_activity_admin_action_redirect', $redirect_to ) );
        exit;
 
 
    // Save the edit.
    } elseif ( $doaction && 'save' == $doaction ) {
        // Build redirection URL.
        $redirect_to = remove_query_arg( array( 'action', 'aid', 'deleted', 'error', 'spammed', 'unspammed', ), $_SERVER['REQUEST_URI'] );
 
        // Get activity ID.
        $activity_id = (int) $_REQUEST['aid'];
 
        // Check this is a valid form submission.
        check_admin_referer( 'edit-activity_' . $activity_id );
 
        // Get the activity from the database.
        $activity = new BP_Activity_Activity( $activity_id );
 
        // If the activity doesn't exist, just redirect back to the index.
        if ( empty( $activity->component ) ) {
            wp_redirect( $redirect_to );
            exit;
        }
 
        // Check the form for the updated properties.
        // Store any error that occurs when updating the database item.
        $error = 0;
 
        // Activity spam status.
        $prev_spam_status = $new_spam_status = false;
        if ( ! empty( $_POST['activity_status'] ) ) {
            $prev_spam_status = $activity->is_spam;
            $new_spam_status  = ( 'spam' == $_POST['activity_status'] ) ? true : false;
        }
 
        // Activity action.
        if ( isset( $_POST['bp-activities-action'] ) )
            $activity->action = $_POST['bp-activities-action'];
 
        // Activity content.
        if ( isset( $_POST['bp-activities-content'] ) )
            $activity->content = $_POST['bp-activities-content'];
 
        // Activity primary link.
        if ( ! empty( $_POST['bp-activities-link'] ) )
            $activity->primary_link = $_POST['bp-activities-link'];
 
        // Activity user ID.
        if ( ! empty( $_POST['bp-activities-userid'] ) )
            $activity->user_id = (int) $_POST['bp-activities-userid'];
 
        // Activity item primary ID.
        if ( isset( $_POST['bp-activities-primaryid'] ) )
            $activity->item_id = (int) $_POST['bp-activities-primaryid'];
 
        // Activity item secondary ID.
        if ( isset( $_POST['bp-activities-secondaryid'] ) )
            $activity->secondary_item_id = (int) $_POST['bp-activities-secondaryid'];
 
        // Activity type.
        if ( ! empty( $_POST['bp-activities-type'] ) ) {
            $actions = bp_activity_admin_get_activity_actions();
 
            // Check that the new type is a registered activity type.
            if ( in_array( $_POST['bp-activities-type'], $actions ) ) {
                $activity->type = $_POST['bp-activities-type'];
            }
        }
 
        // Activity timestamp.
        if ( ! empty( $_POST['aa'] ) && ! empty( $_POST['mm'] ) && ! empty( $_POST['jj'] ) && ! empty( $_POST['hh'] ) && ! empty( $_POST['mn'] ) && ! empty( $_POST['ss'] ) ) {
            $aa = $_POST['aa'];
            $mm = $_POST['mm'];
            $jj = $_POST['jj'];
            $hh = $_POST['hh'];
            $mn = $_POST['mn'];
            $ss = $_POST['ss'];
            $aa = ( $aa <= 0 ) ? date( 'Y' ) : $aa;
            $mm = ( $mm <= 0 ) ? date( 'n' ) : $mm;
            $jj = ( $jj > 31 ) ? 31 : $jj;
            $jj = ( $jj <= 0 ) ? date( 'j' ) : $jj;
            $hh = ( $hh > 23 ) ? $hh -24 : $hh;
            $mn = ( $mn > 59 ) ? $mn -60 : $mn;
            $ss = ( $ss > 59 ) ? $ss -60 : $ss;
 
            // Reconstruct the date into a timestamp.
            $gmt_date = sprintf( "%04d-%02d-%02d %02d:%02d:%02d", $aa, $mm, $jj, $hh, $mn, $ss );
 
            $activity->date_recorded = $gmt_date;
        }
 
        // Has the spam status has changed?
        if ( $new_spam_status != $prev_spam_status ) {
            if ( $new_spam_status )
                bp_activity_mark_as_spam( $activity );
            else
                bp_activity_mark_as_ham( $activity );
        }
 
        // Save.
        $result = $activity->save();
 
        // Clear the activity feed first page cache, in case this activity's timestamp was changed.
        wp_cache_delete( 'bp_activity_sitewide_front', 'bp' );
 
        // Check for any error during activity save.
        if ( false === $result )
            $error = $activity->id;
 
        /**
         * Fires before redirect so plugins can do something first on save action.
         *
         * @since BuddyPress 1.6.0
         *
         * @param array $value Array holding activity object and ID that holds error.
         */
        do_action_ref_array( 'bp_activity_admin_edit_after', array( &$activity, $error ) );
 
        // If an error occurred, pass back the activity ID that failed.
        if ( $error )
            $redirect_to = add_query_arg( 'error', $error, $redirect_to );
        else
            $redirect_to = add_query_arg( 'updated', $activity->id, $redirect_to );
 
        /**
         * Filters URL to redirect to after saving.
         *
         * @since BuddyPress 1.6.0
         *
         * @param string $redirect_to URL to redirect to.
         */
        wp_redirect( apply_filters( 'bp_activity_admin_edit_redirect', $redirect_to ) );
        exit;
 
 
    // If a referrer and a nonce is supplied, but no action, redirect back.
    } elseif ( ! empty( $_GET['_wp_http_referer'] ) ) {
        wp_redirect( remove_query_arg( array( '_wp_http_referer', '_wpnonce' ), stripslashes( $_SERVER['REQUEST_URI'] ) ) );
        exit;
    }
}

Changelog

Changelog
Version Description
BuddyPress 1.6.0 Introduced.

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.