 |
VOOZH | about |
|
VOOZH | about |
This document provides technical guidance for installing and configuring the BuddyPress VIP Go plugin on WordPress VIP environments. It covers system prerequisites, installation procedures, activation sequence requirements, environment detection mechanisms, and verification steps. For information about plugin architecture and how it integrates with VIP Go FHS, see System Architecture. For development setup including local testing environments, see Local Development Setup.
The plugin has strict version and environment requirements that must be met before installation.
| Component | Minimum Version | Location in Code |
|---|---|---|
| WordPress | 6.6 | buddypress-vip-go.php14 |
| PHP | 8.2 | buddypress-vip-go.php15 |
| BuddyPress | Any compatible version | Detected via bp_loaded hook |
The plugin performs runtime detection of three VIP-specific environment markers. All three must be present for the integration layer to load:
| Requirement | Type | Detection Method | Code Reference |
|---|---|---|---|
| VIP Files Client | PHP Class | class_exists( 'A8C_Files' ) | buddypress-vip-go.php28 |
| Site ID Configuration | PHP Constant | defined( 'FILES_CLIENT_SITE_ID' ) | buddypress-vip-go.php28 |
| Access Token | PHP Constant | defined( 'FILES_ACCESS_TOKEN' ) | buddypress-vip-go.php28 |
Note: These environment markers are automatically provided by WordPress VIP infrastructure. They cannot be manually configured. If running outside VIP Go, the plugin remains dormant and does not interfere with normal BuddyPress operation.
Sources: buddypress-vip-go.php14-15 buddypress-vip-go.php28 README.md5-8
The plugin must be activated before BuddyPress to prevent fatal errors during BuddyPress initialization. This is because the plugin registers hooks that modify BuddyPress's media handling behavior before BuddyPress attempts filesystem operations that would fail on VIP Go.
Title: Installation Activation Sequence
Sources: README.md50-53
Upload Plugin Files
buddypress-vip-go directory in /wp-content/plugins/Verify Environment (VIP Go Only)
Activate in Correct Order
No Configuration Required
Sources: README.md48-53
The plugin uses a defense-in-depth approach to environment detection, only loading the VIP integration layer when all conditions are satisfied.
Title: VIP Environment Detection Logic Flow
Sources: buddypress-vip-go.php25-34
The detection logic maps to specific code constructs in buddypress-vip-go.php25-34:
| Detection Check | PHP Code | Purpose |
|---|---|---|
| BuddyPress Ready | add_action( 'bp_loaded', ... ) | Waits for BuddyPress to initialize |
| VIP Files Client | class_exists( 'A8C_Files' ) | Confirms VIP Files API is available |
| Site Configuration | defined( 'FILES_CLIENT_SITE_ID' ) | Verifies site is registered with VIP FHS |
| Authentication | defined( 'FILES_ACCESS_TOKEN' ) | Confirms API authentication credentials exist |
| Integration Load | require_once __DIR__ . '/files.php' | Loads core integration layer |
The variable $vip_available at buddypress-vip-go.php28 contains the combined boolean result of all three checks.
Sources: buddypress-vip-go.php25-34
After activation, verify the plugin is functioning correctly:
Title: Plugin Activation Verification Sequence
| Check | Expected Result | Indicates |
|---|---|---|
| Plugin listed as active | "BuddyPress VIP Go" appears in active plugins | Plugin files loaded correctly |
| No PHP errors on activation | No error messages displayed | Dependencies met, syntax valid |
| BuddyPress settings accessible | Settings pages load without errors | Compatible BuddyPress version |
| Avatar upload test | Upload succeeds without filesystem errors | VIP integration active (VIP only) |
No opendir() errors | System logs show no filesystem warnings | Hooks registered before BP operations |
Sources: buddypress-vip-go.php25-34 README.md50-53
On standard WordPress installations (non-VIP), the plugin exhibits the following behavior:
This design allows the plugin to be safely present in version control repositories used across multiple environments (local development, staging, production).
Sources: buddypress-vip-go.php25-34
The plugin implements a zero-configuration architecture. All operational parameters are derived automatically from:
No WordPress admin screens, settings pages, or configuration constants exist for this plugin.
Title: Zero-Configuration Architecture Flow
Sources: buddypress-vip-go.php25-34 README.md50-53
| Aspect | Configuration Method | Code Reference |
|---|---|---|
| VIP FHS integration | Detected via A8C_Files class | buddypress-vip-go.php28 |
| File upload paths | Handled by VIP wp_handle_upload() | files.php |
| CDN delivery URLs | Generated via VIP Files API | files.php |
| Image transformations | Query parameters appended to URLs | files.php |
| Metadata storage keys | Hardcoded: vipbp-avatars, vipbp-group-avatars, etc. | files.php |
Sources: buddypress-vip-go.php28 README.md32-35
In WordPress multisite networks:
Updates follow standard WordPress plugin update mechanisms:
Deactivating the plugin:
Warning: Deactivating this plugin on WordPress VIP will immediately break all BuddyPress media functionality.
Sources: buddypress-vip-go.php1-35 README.md48-53
| Symptom | Cause | Solution |
|---|---|---|
| Fatal error on BuddyPress activation | Wrong activation order | Deactivate BuddyPress, activate VIP Go plugin first, then reactivate BuddyPress |
opendir() errors in logs | VIP Go plugin activated after BP | Deactivate both plugins, activate in correct order |
| Media uploads fail on VIP | Environment constants missing | Contact VIP support to verify FHS provisioning |
| Plugin shows as active but has no effect | Not running on VIP infrastructure | Expected behavior - plugin is dormant outside VIP |
To diagnose installation issues, check the following values (via debug logging or temporary diagnostic code):
All checks should return true on a properly configured VIP Go environment with BuddyPress active.
Sources: buddypress-vip-go.php25-34
For topics beyond basic installation and configuration:
Sources: README.md1-62 buddypress-vip-go.php1-35
Refresh this wiki