Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/extra-chill/extrachill-community

community.extrachill.com WordPress plugin. Extends bbPress
https://github.com/extra-chill/extrachill-community

bbpress wordpress-theme

Last synced: 5 months ago
JSON representation

community.extrachill.com WordPress plugin. Extends bbPress

Awesome Lists containing this project

README 

          
# Extra Chill Community Plugin



A WordPress plugin for the Extra Chill community platform providing forum enhancements and bbPress integration. Works with the extrachill theme to provide community functionality for community.extrachill.com.



 **Version**: 1.2.3



## Overview



**Extra Chill Community** is a WordPress plugin providing community functionality:

- `community.extrachill.com` - Main community platform (WordPress/bbPress) **[Uses extrachill theme + this plugin]**

- `extrachill.com` - Main website **[Uses extrachill theme + cross-domain integration]**



## Plugin Basics



```bash

composer install

```



### Automatic Setup



When you activate the plugin, it automatically creates all required pages and forums for you:



**Pages Created** (5 total):

- **Settings** (`/settings`) - Account settings, email, password, subscriptions

- **Notifications** (`/notifications`) - User notification display

- **Recent Activity** (`/recent`) - Community activity feed

- **Leaderboard** (`/leaderboard`) - User rankings and points

- **Blog Comments** (`/blog-comments`) - Main blog comments aggregation



**Forums Created** (2 total):

- **Local Scenes** (`/r/local-scenes`) - Discuss local music scenes

- **Music Discussion** (`/r/music-discussion`) - General music discussion



No manual page creation needed - everything is ready to use immediately after activation!



### Plugin Structure



```

extrachill-community/

├── extrachill-community.php      # Main plugin file

├── inc/                          # Core plugin functionality

│   ├── core/                     # Assets, bbPress templates, breadcrumb filter, page templates, spam adjustments, sidebar, nav, cache invalidation (8 files)

│   ├── content/                  # Editor (2), content filters, recent feed, main site comments, subforum button classes (6 files)

│   ├── social/                   # Upvoting, mentions, badges

│   │   ├── notifications/        # Notification system (7 files)

│   │   └── rank-system/          # Point calculation, forum rank (2 files)

│   ├── user-profiles/            # Profiles, verification (2 files)

│   │   ├── settings/             # Settings content and form handler (2 files)

│   │   └── edit/                 # User links, user info, avatar upload (3 files)

│   ├── home/                     # Homepage components (7 files)

│   └── assets/                   # CSS and JS files

│       ├── css/                  # 11 CSS files

│       └── js/                   # 6 JavaScript files

├── page-templates/               # Custom page templates (3 templates)

├── bbpress/                      # bbPress template overrides

└── vendor/                       # Composer dependencies

```



## Plugin Dependencies



### Required Plugins

- **bbPress** - Forum functionality (enforced via plugin headers)

- **extrachill theme** - Template integration and styling



### Optional Plugin Integration



**extrachill-artist-platform**:

- Provides `ec_can_create_artist_profiles($user_id)` for artist permission checks

- Artist status badges display in forums

- Artist platform homepage buttons on community homepage



**extrachill-users**:

- Provides `ec_is_team_member($user_id)` for team member badge system

- Supports manual admin overrides for team member status

- Provides `ec_avatar_menu_items` filter for cross-plugin navigation



### Cross-Site Integration

- Main site (blog ID 1) data aggregation for user profiles

- Post count display from extrachill.com

- Comment aggregation from main site blog

- Point calculation includes main site post contributions (10pts each)



## Core Features



The plugin integrates deeply with bbPress for forum functionality, with optional integrations to extrachill-artist-platform (artist badges and CTAs) and extrachill-users (team member badges and avatar menu). All integrations use function_exists() checks for graceful degradation when optional plugins are not active.



### 1. Forum Features System



**Explicit Loading Pattern** - All functionality loaded in `extrachill_community_init()`:

```php

// Main plugin file uses 36 direct require_once statements (NO master loader file)

// Load order: core (8) → content (6) → social (11) → user-profiles (7) → home (4)



// Core features (8 files): assets, bbPress templates, breadcrumb filter, page templates, spam adjustments, sidebar, nav, cache invalidation

// Content features (6 files): TinyMCE editor (2), content filters, recent feed, main site comments, subforum button classes

// Social features (11 files): upvoting, badges, rank system (2), notifications (7)

// User profile features (7 files): profiles, verification, settings (2), edit (3)

// Home features (4 files): latest post, actions, forum display, artist platform buttons



// Total: 36 files loaded in init function



// Deprecated (not loaded): inc/social/user-mention-api.php (moved to extrachill-api plugin)

// Moved to extrachill-users plugin: Avatar system, online-users-count.php, user-avatar-menu.php

```



**bbPress Integration**:

```php

// Plugin enhances bbPress functionality with conditional loading

if (bbp_is_forum_archive() || is_front_page() || bbp_is_single_forum()) {

    wp_enqueue_style('community-home',

        EXTRACHILL_COMMUNITY_PLUGIN_URL . '/inc/assets/css/home.css',

        ['extra-chill-community-style'],

        filemtime(EXTRACHILL_COMMUNITY_PLUGIN_DIR . '/inc/assets/css/home.css')

    );

}

```



### 2. Homepage Integration



Community homepage content is rendered on `community.extrachill.com` via the theme action hook `extrachill_homepage_content`.



### 3. User Management & Notifications



**User Profile System**:

```php

// User can add multiple social/music platform links

$existing_links = get_user_meta($user_id, '_user_profile_dynamic_links', true);



// Supported link types: website, instagram, twitter, facebook, spotify, soundcloud, bandcamp

```



**Notification System**:

```php

// Header notification bell with unread count

$notifications = get_user_meta($current_user_id, 'extrachill_notifications', true);

$unread_count = count(array_filter($notifications, function($n) { return !$n['read']; }));



// User avatar dropdown menu extensible via ec_avatar_menu_items filter (provided by extrachill-users plugin)

```



### 4. Cross-Site Integration



- Cross-site aggregation for profile stats uses `switch_to_blog()` / `restore_current_blog()` (e.g., main-site post/comment counts)

- Interactive features use REST routes registered by the network-activated `extrachill-api` plugin



## Development



### Asset Management



**CSS Loading** (11 files in inc/assets/css/):

```php

// Modular CSS with conditional loading

function modular_bbpress_styles() {

    if (bbp_is_forum_archive() || is_front_page() || bbp_is_single_forum()) {

        wp_enqueue_style('community-home',

            EXTRACHILL_COMMUNITY_PLUGIN_URL . '/inc/assets/css/home.css',

            ['extrachill-bbpress'],

            filemtime(EXTRACHILL_COMMUNITY_PLUGIN_DIR . '/inc/assets/css/home.css')

        );

    }

}



// All CSS files: bbpress.css, blog-comments-feed.css, global.css, home.css, leaderboard.css,

// notifications.css, replies-loop.css, settings-page.css, tinymce-editor.css, topics-loop.css, user-profile.css

```



**JavaScript Architecture** (6 files in inc/assets/js/):

```php

// Loaded via assets.php (3 files):

// - upvote.js (bbPress and recent page)

// - bbpress-ui.js (bbPress only)

// - bbpress-tinymce.js (bbPress editor contexts only)

// - tinymce-image-upload.js (TinyMCE image upload helper)

// - content-expand.js (recent page, blog comments feed)



// Loaded independently by feature modules (2 files):

// - manage-user-profile-links.js (by inc/user-profiles/edit/user-links.php)

// - avatar-upload.js (by inc/user-profiles/edit/avatar-upload.php)



// Removed files:

// - custom-avatar.js (moved to extrachill-users plugin)

```



### Database Schema



**Meta Fields**:

```php

// Theme meta fields

get_post_meta($forum_id, '_show_on_homepage'); // Boolean for homepage display

get_user_meta($user_id, '_user_profile_dynamic_links'); // User social links

get_user_meta($user_id, 'ec_custom_title'); // Custom user titles

get_user_meta($user_id, 'extrachill_notifications'); // User notification data

get_user_meta($user_id, 'user_is_artist'); // Artist account flag

get_user_meta($user_id, 'user_is_professional'); // Professional account flag

```



### Template System



**Page Templates** (3 templates in page-templates/):

```php

// Template Name: Leaderboard

// page-templates/leaderboard-template.php - Community leaderboard with user rankings



// Template Name: Recent Feed

// page-templates/recent-feed-template.php - Recent community activity



// Template Name: Main Blog Comments Feed

// page-templates/main-blog-comments-feed.php - Cross-domain blog comments

```



**Settings Page** (Hook-Based):

```php

// Settings page uses action hooks instead of template file

// inc/user-profiles/settings/settings-content.php - Content rendering

// inc/user-profiles/settings/settings-form-handler.php - Form processing

```



**bbPress Template Overrides** (bbpress/ directory):

```php

// Core templates:

// - bbpress.php (main wrapper), content-single-forum.php, content-single-topic.php

// - loop-forums.php, loop-topics.php, loop-replies.php (containers)

// - loop-single-forum-card.php, loop-single-topic-card.php, loop-single-reply-card.php (cards)

// - loop-subforums.php (subforum display)

// - form-topic.php, form-reply.php (custom forms with TinyMCE)

// - pagination-topics.php, pagination-replies.php, pagination-search.php

// - user-profile.php, user-details.php (enhanced profiles)

```



## Configuration



### Filter System



The theme provides a filter system for plugins to extend functionality without modifying theme files.



#### Avatar Menu Filter



The `ec_avatar_menu_items` filter (provided by extrachill-users plugin) allows plugins to add custom menu items to the user avatar dropdown menu:



```php

add_filter( 'ec_avatar_menu_items', 'my_plugin_avatar_menu_items', 10, 2 );



function my_plugin_avatar_menu_items( $menu_items, $user_id ) {

    // Example: Add custom menu items for community features

    $is_artist = get_user_meta( $user_id, 'user_is_artist', true );



    if ( $is_artist === '1' ) {

        $menu_items[] = array(

            'url'      => home_url( '/artist-dashboard/' ),

            'label'    => __( 'Artist Dashboard', 'textdomain' ),

            'priority' => 5  // Appears before settings

        );

    }



    // Add general community menu item

    $menu_items[] = array(

        'url'      => home_url( '/community-features/' ),

        'label'    => __( 'Community Features', 'textdomain' ),

        'priority' => 10

    );



    return $menu_items;

}

```



**Menu Item Structure:**

- `url` (string, required) - The menu item URL

- `label` (string, required) - The menu item display text

- `priority` (int, optional) - Sort order (default: 10, lower = higher in menu)



**Note**: This filter is PROVIDED by the extrachill-users plugin, not this plugin. Community plugin can use this filter to add menu items.



### Plugin Setup



```php

// Main plugin file: extrachill_community_init() with 36 explicit require_once statements

function extrachill_community_init() {

    // Core (8): assets, bbpress-templates, breadcrumb-filter, page-templates, bbpress-spam-adjustments, sidebar, nav, cache-invalidation

    // Content (6): tinymce (2), content-filters, recent-feed, main-site-comments, subforum-button-classes

    // Social (11): upvote, badges, rank-system (2), notifications (7)

    // User Profiles (7): profile, verification, settings (2), edit (3)

    // Home (4): latest-post, actions, homepage-forum-display, artist-platform-buttons



    // See extrachill-community.php lines 30-76 for complete explicit loading

}

add_action('plugins_loaded', 'extrachill_community_init');

```



### Performance Optimization



**bbPress Optimization**:

```php

// Dequeue default bbPress styles to prevent conflicts

function extrachill_dequeue_bbpress_default_styles() {

    wp_dequeue_style('bbp-default');

}

add_action('wp_enqueue_scripts', 'extrachill_dequeue_bbpress_default_styles', 15);

```



## REST Endpoints (used by frontend JS)



Certain interactive features use REST routes registered by the network-activated `extrachill-api` plugin.



- `POST /wp-json/extrachill/v1/community/upvote`

  - Used by `inc/assets/js/upvote.js`

  - Delegates into `extrachill_process_upvote()` (in this plugin)



(User mention autocomplete is also provided via `extrachill-api`.)



## Testing



```bash

# Testing Areas:

# 1. Plugin Loading: Verify all 36 files load via explicit require_once in extrachill_community_init()

# 2. Forum Features: Core (8), content (6), social (11), user-profiles (7), home (4)

# 3. Multisite Integration: WordPress authentication

# 4. bbPress Integration: Custom templates, breadcrumb filter, stylesheet conflicts, functionality

# 5. JavaScript Components: 3 via assets.php, 2 independent loaders

# 6. User Management: Profiles, settings, verification, notifications

# 7. Social Features: Upvoting, badges, rank system (2 files)

# 8. Notification System: 7 notification files in inc/social/notifications/

# 9. Hook-Based Components: Homepage and settings page action hooks

# 10. User Avatar Menu: ec_avatar_menu_items filter provided by extrachill-users plugin

```



## Deployment



**Production Setup**:

1. Install plugin on community.extrachill.com WordPress

2. Activate extrachill theme

3. Activate bbPress plugin (required)

4. Activate extrachill-community plugin

5. Ensure multisite cookies are configured

6. Run `composer install` for PHP dependencies



**Domain Configuration**:

```php

// wp-config.php additions for cross-domain

define('COOKIE_DOMAIN', '.extrachill.com');

define('EXTRACHILL_API_URL', 'https://community.extrachill.com');



// Note: cookie and auth behavior is configured at the network level (WordPress multisite + network plugins).

```



## Architecture Notes



- **Plugin Architecture**: WordPress plugin providing community functionality that integrates with extrachill theme

- **Theme Integration**: Works seamlessly with extrachill theme on community.extrachill.com

- **Plugin Integration**: Works with other community plugins via filters and hooks

- **No Build System**: Direct file inclusion, no compilation required

- **Explicit Loading Architecture**: 36 files loaded in init function (NO master loader file)

- **Organized Structure**: Core (8), content (6), social (11), user-profiles (7), home (4)

- **WordPress Native**: Full compliance with WordPress plugin development standards

- **Performance Focused**: Conditional asset loading, dynamic versioning, modular CSS (11 files), 6 JS files (3 via assets.php, 2 independent)

- **Cross-Domain Ready**: WordPress multisite native authentication exclusively (migration complete)

- **Hook-Based Components**: Homepage and settings use action hooks for extensibility

- **Filter System**: ec_avatar_menu_items filter provided by extrachill-users plugin for cross-plugin integration



## License



GPL v2 or later - https://www.gnu.org/licenses/gpl-2.0.html



## Author



**Chris Huber** - https://chubes.net