Audit & replace $bp global touches with wrapper functions & methods

[johnjamesjacoby]

BuddyPress touches the $bp global directly countless times. In the past, this was fine enough, as it gave us an easy and reliable way to get global data relative to BuddyPress's current state. As BuddyPress becomes more robust, this is becoming more fragile, more difficult to extend, and a bottleneck for future enhancements to the software.

One specific case is adding rewrite rules, a feature slated for 1.8, bumped to 1.9.

Because we directly reference $bp->loggedin_user->domain inside templates, functions, methods, and classes, translating that reference into an unpretty permalink becomes problematic, as existing plugins have come to expect that it is always a pretty URL.

Another case is the $bp->pages array. As we introduce rewrite rules, our dependance on this array will disappear, though because we reference it directly in 60+ places, we're forced to touch these references rather than using a function and replacing its guts.

There are numerous other examples that require ongoing clean-up, both related and unrelated to adding rewrite rules in 1.9 and beyond. I'm creating this ticket as a general task to patch and commit changes to $bp touches towards.

[johnjamesjacoby]

$bp->loggedin_user->domain ended up being a bad example, as I cleaned most of that up during the epic 1.5 release.

[johnjamesjacoby]

In r7749:

Replace $bp global references in slug functions with buddypress() calls. See #5138.

[johnjamesjacoby]

In 7751:

Replace $bp global references in slug functions with buddypress() calls. See #5138. (trunk)

[johnjamesjacoby]

In 8181:

Remove $bp global from core messages functions. See #5138.

[johnjamesjacoby]

In 8182:

Replace $bp global touches in core component functions with buddypress() calls. See #5138.

[johnjamesjacoby]

In 9373:

Coding standards improvements to BP_Activity_Activity::save(). See #5138, #5891.

[johnjamesjacoby]

In 9374:

Add brackets and remove $bp global touch in BP_Activity_Activity::get_id(). See #5138, #5891.

[johnjamesjacoby]

In 9377:

Harden BP_Activity_Activity::rebuild_activity_comment_tree() by using intval() on recursively returned values, and use wp_list_pluck() to avoid touching object id directly. Also remove $bp global touch. See #5138.

[johnjamesjacoby]

In 9378:

Remove $bp global touches in bp-activity-classes.php. See #5138.

[DJPaul]

I just ran Scrutiniser to evaluate these changes (specifically r9377) and it thinks Activity::rebuild_activity_comment_tree() got "worse" though it is not clear to me why it thinks that: ​https://scrutinizer-ci.com/g/buddypress/BuddyPress/inspections/979b3a27-156d-4e63-9758-7fd68adf831c

[johnjamesjacoby]

Looks like in the case of the save() method, it's due to the added length of the method thanks to the extra brackets. Either way, what we have now conforms and is easier on the eyes.

[johnjamesjacoby]

In 9470:

Beautify /deprecated/2.1.php:

• Add brackets
• Remove $bp global touches (See #5138)
• Use bp_is_root_blog() rather than direct comparisons to bp_get_root_blog()
• Easier to navigate when testing & debugging deprecated functionality

[johnjamesjacoby]

In 9471:

Replace all remaining $bp global touches with buddypress().

All existing tests continue to pass as normal. I will further manually scrutinize each replacement to ensure correctness.

Fixes #5138. Any stragglers or updates will reference this ticket.

[johnjamesjacoby]

In 9536:

Activity: Clean up bp_has_activities():

• Remove $bp global usage. See #5138.
• Remove extract() usage. See #5698.
• Remove one-time-use variables.
• Consolidate arrays for improved readability.

[johnjamesjacoby]

In 9649:

Activity: Remove unused $bp references from bp-activity-functions.php. See #5138.