 |
VOOZH | about |
|
VOOZH | about |
This document provides an overview of how the BuddyPress VIP Go plugin handles media operations for avatars, cover images, and videos. It explains the core principles that differentiate this plugin's approach from standard BuddyPress media handling, introduces the major media types supported, and maps the high-level workflows to specific code functions.
For detailed information about specific media operations, see:
For information about how the plugin integrates with VIP's file hosting infrastructure, see VIP File Hosting Service Integration. For metadata storage details, see Metadata Storage Architecture.
The plugin implements three fundamental principles that distinguish it from standard BuddyPress media handling:
Instead of storing multiple pre-generated image sizes on the filesystem, the plugin stores only the original uploaded file in VIP FHS and saves transformation metadata in the WordPress database. For avatars, this includes crop coordinates (crop_x, crop_y, crop_w, crop_h) and UI width constraints. For cover images, only the URL is stored since they use a fixed crop pattern.
Image transformations (cropping, resizing) are performed on-demand by VIP's file hosting service via Photon-like query parameters. When BuddyPress requests an avatar at a specific size, the plugin constructs a URL with parameters like ?w=150&crop=x,y,w,h&resize=150,150&strip=info that instruct VIP FHS to transform the image dynamically. This eliminates storage overhead and leverages VIP's CDN for caching.
The plugin completely bypasses BuddyPress's filesystem scanning operations by intercepting hooks early in the execution flow. It returns empty strings for directory paths files.php16 and provides URLs directly from metadata, preventing opendir() and flock() calls that would fail on VIP's distributed filesystem.
Sources: files.php1-967 README.md24-42
The plugin handles four distinct media types, each with different processing requirements:
| Media Type | Metadata Key(s) | Storage Location | Transformation Method | Special Handling |
|---|---|---|---|---|
| User Avatars | vipbp-avatars | User Meta | Dynamic crop + resize | Supports webcam capture |
| Group Avatars | vipbp-group-avatarsvipbp-default-group-avatar | Group Meta / Options | Dynamic crop + resize | Default avatar uses options table |
| User Cover Images | vipbp-user-cover | User Meta | Fixed crop pattern | Middle 25% vertical crop |
| Group Cover Images | vipbp-group-cover | Group Meta | Fixed crop pattern | Middle 25% vertical crop |
| Videos | N/A (BuddyBoss) | VIP FHS | None | Chunked upload to local temp |
Avatar metadata structure:
array(
'url' => 'https://example.com/uploads/...',
'crop_x' => 0,
'crop_y' => 0,
'crop_w' => 150,
'crop_h' => 150,
'ui_width' => 500
)
Cover image metadata structure:
array(
'url' => 'https://example.com/uploads/...'
)
Sources: files.php32-42 README.md30-36
The plugin registers filters on BuddyPress hooks to intercept default media operations. These filters are registered in two phases: early filters (before bp_init priority 8) prevent filesystem operations, while bp_init filters override upload, crop, and deletion handlers.
Sources: files.php11-52
This diagram illustrates the complete lifecycle of media from upload through storage to retrieval and display, showing how each phase maps to specific functions.
Sources: files.php336-464 files.php679-738 files.php70-256
This table maps media operations to the specific functions that handle them, providing a quick reference for understanding code flow.
| Operation | User Avatars | Group Avatars | User Covers | Group Covers | Videos |
|---|---|---|---|---|---|
| Upload | vipbp_handle_avatar_uploadfiles.php336-464 | vipbp_handle_avatar_uploadfiles.php336-464 | vip_handle_cover_image_uploadfiles.php562-649 | vip_handle_cover_image_uploadfiles.php562-649 | vipbp_filter_chunked_upload_temp_dirfiles.php923-925 |
| Webcam Capture | vipbp_handle_avatar_capturefiles.php476-545 | N/A | N/A | N/A | N/A |
| Crop | vipbp_handle_avatar_cropfiles.php679-738 | vipbp_handle_avatar_cropfiles.php679-738 | N/A (fixed pattern) | N/A (fixed pattern) | N/A |
| URL Generation | vipbp_filter_user_avatar_urlsfiles.php70-89 → vipbp_filter_avatar_urlsfiles.php148-256 | vipbp_filter_group_avatar_urlsfiles.php106-136 → vipbp_filter_avatar_urlsfiles.php148-256 | vipbp_filter_get_cover_imagefiles.php277-324 | vipbp_filter_get_cover_imagefiles.php277-324 | N/A |
| Deletion | vipbp_delete_existing_avatarfiles.php761-836 | vipbp_delete_existing_avatarfiles.php761-836 | vipbp_delete_cover_imagefiles.php847-875 | vipbp_delete_cover_imagefiles.php847-875 | vipbp_override_remove_temp_directoryfiles.php886-897 |
| Cache Management | N/A | N/A | N/A | N/A | vipbp_flush_cache_after_video_movefiles.php905-907 |
Sources: files.php23-52
All metadata is stored on the root blog in multisite installations via switch_to_blog(bp_get_root_blog_id()) files.php74-75 This centralization simplifies metadata management across network sites.
vipbp-avatars (User Meta)
url, crop_x, crop_y, crop_w, crop_h, ui_widthvipbp_filter_user_avatar_urls() files.php81vipbp_handle_avatar_upload() files.php402-413 vipbp_handle_avatar_capture() files.php518-529vipbp_delete_existing_avatar() files.php811vipbp-group-avatars (Group Meta)
url, crop_x, crop_y, crop_w, crop_h, ui_widthvipbp_filter_group_avatar_urls() files.php120vipbp_handle_avatar_upload() files.php429-433vipbp_delete_existing_avatar() files.php819-820vipbp-default-group-avatar (BP Option)
item_id=0 (stored in options instead of group meta since no group exists)vipbp-group-avatarsvipbp_filter_group_avatar_urls() files.php117 vipbp_filter_default_group_avatar_option() files.php942vipbp_handle_avatar_upload() files.php427vipbp_delete_existing_avatar() files.php816-817vipbp-user-cover (User Meta)
urlvipbp_filter_get_cover_image() files.php289vip_handle_cover_image_upload() files.php611-617vipbp_delete_cover_image() files.php857-858vipbp-group-cover (Group Meta)
urlvipbp_filter_get_cover_image() files.php294vip_handle_cover_image_upload() files.php619-626vipbp_delete_cover_image() files.php861-862Sources: files.php70-875 README.md30-36
When item_id=0 is used for the default group avatar, the plugin stores metadata in the vipbp-default-group-avatar option instead of group meta (since no group exists). This requires special logic in multiple functions:
opendir() PreventionBuddyBoss's bb_get_default_custom_upload_group_avatar() function calls bb_get_default_custom_avatar(), which uses opendir() to scan the filesystem. This fails on VIP Go. The plugin prevents this by:
option_bp-default-custom-group-avatar to return empty when a VIP avatar exists files.php941-946bb_get_default_custom_upload_group_avatar to return the stored URL files.php958-965This two-filter approach bypasses the problematic BuddyBoss code path while still providing the correct avatar URL.
BuddyBoss's chunked video upload mechanism requires flock() for file locking during chunk assembly. VIP FHS doesn't support flock(), so the plugin redirects chunked uploads to the local temp directory where file locking works files.php923-925 After assembly completes, BuddyBoss moves the final file to VIP FHS using standard upload mechanisms.
Sources: files.php20-21 files.php115-127 files.php426-427 files.php710-728 files.php815-817 files.php923-925 files.php941-965
The plugin's filters are designed to short-circuit BuddyPress's default media handling by returning non-null values on pre_ filters. When a pre_ filter returns a non-null value, BuddyPress skips its default processing logic. The plugin's functions return false (for operations that succeeded) or arrays (for cover image uploads) to indicate the operation was handled.
Refresh this wiki