 |
VOOZH | about |
|
VOOZH | about |
This document provides a high-level introduction to the BuddyPress VIP Go plugin, explaining its purpose, the problems it solves, and its architectural approach. The plugin enables BuddyPress social networking features to work correctly on WordPress VIP Go's hosting platform by adapting media handling to VIP's distributed file system.
This overview covers the plugin's core purpose, its structural design, and the fundamental concepts that drive its implementation. For detailed information about specific subsystems, see:
Sources: README.md1-62 buddypress-vip-go.php1-35 AGENTS.md1-78
WordPress VIP Go uses a distributed file hosting service (VIP FHS) instead of the standard WordPress local file system. This architectural difference creates fundamental incompatibilities with BuddyPress's default media handling:
| Standard WordPress Behavior | VIP Go Limitation | Impact on BuddyPress |
|---|---|---|
Direct file system operations (opendir(), flock()) | Distributed storage without local file system | Avatar folder scanning fails |
| Multiple image sizes pre-generated | Storage optimization needed | Wasteful on distributed storage |
| Local temporary directories | Ephemeral containers | Chunked uploads fail |
| Attachment post system | Metadata-only approach preferred | Need alternative storage strategy |
Without this plugin, BuddyPress sites on VIP Go experience failures in avatar uploads, cover image management, group video uploads, and media deletion operations.
Sources: README.md13-22 AGENTS.md64-68
The plugin consists of two primary PHP files totaling approximately 32 KB of code, plus supporting development infrastructure:
Diagram 1: Plugin File Structure
The intentionally minimal structure reflects the plugin's focused purpose: providing a compatibility shim between BuddyPress and VIP Go. The files.php file is deliberately monolithic because its logic is tightly coupled to VIP FHS operations.
Sources: AGENTS.md16-29 buddypress-vip-go.php1-35
The plugin activates only when running on VIP Go infrastructure. It performs three distinct environment checks before loading the integration layer:
Diagram 2: Environment Detection Logic
The three-tier validation ensures the plugin only activates when:
A8C_Files) is availableThis defense-in-depth approach prevents activation errors on non-VIP environments or misconfigured VIP sites.
Sources: buddypress-vip-go.php25-34 AGENTS.md64-68
Unlike standard WordPress media operations that create physical image files for multiple sizes, this plugin implements a metadata-driven architecture:
Diagram 3: Metadata-Driven vs. Standard Media Handling
The plugin stores different metadata keys for different media types:
| Meta Key | Context | Data Stored | Location |
|---|---|---|---|
vipbp-avatars | User avatars | url, crop_x, crop_y, crop_w, crop_h, ui_width, filename | User meta table |
vipbp-group-avatars | Group avatars | url, crop_x, crop_y, crop_w, crop_h, ui_width, filename | Group meta table |
vipbp-default-group-avatar | Default group avatar | url, crop_x, crop_y, crop_w, crop_h, ui_width, filename | BP options table |
vipbp-user-cover | User cover images | url only (fixed crop pattern) | User meta table |
vipbp-group-cover | Group cover images | url only (fixed crop pattern) | Group meta table |
Sources: README.md28-36
The plugin's functionality maps to specific code constructs throughout the codebase:
Diagram 4: Code Entity Mapping
This diagram maps high-level concepts to actual function names that implement the plugin's functionality. Each function integrates with BuddyPress via WordPress's hook system.
Sources: buddypress-vip-go.php1-35 README.md28-46
The plugin does not modify BuddyPress or WordPress core code. Instead, it registers filters and actions that intercept media operations:
Diagram 5: Hook-Based Integration Example (Avatars)
By returning non-false values from pre-operation filters, the plugin signals BuddyPress to skip its default file system operations. This approach maintains compatibility with BuddyPress updates while adapting its behavior for VIP Go.
Sources: README.md28-42
The plugin handles four categories of BuddyPress media:
flock() operationswp_delete_file()For detailed workflows of each media type, see Media Operations.
Sources: README.md28-46
| Requirement | Value | Reason |
|---|---|---|
| WordPress Version | 6.6+ | Required for modern hook priorities and multisite support |
| PHP Version | 8.2+ | VIP Go platform requirement |
| BuddyPress | Required | Plugin extends BuddyPress functionality |
| VIP Go Platform | Required | Plugin specifically designed for VIP FHS integration |
| BuddyBoss | Optional | Additional compatibility hooks included |
The plugin validates these constants before activation:
A8C_Files class must exist (VIP File Service class)FILES_CLIENT_SITE_ID must be defined (site identifier for VIP FHS)FILES_ACCESS_TOKEN must be defined (authentication credentials)Sources: buddypress-vip-go.php14-28 README.md5-6
The plugin uses the text domain buddypress-vip-go for all translatable strings. Translation files are generated from source code and stored in the languages/ directory.
Sources: buddypress-vip-go.php17 AGENTS.md10-61
For complete version history and changelog, see Version History.
Sources: buddypress-vip-go.php3-19 README.md7-9
For detailed information about specific aspects of the plugin:
Sources: README.md1-62 AGENTS.md1-78
Refresh this wiki