OForum v1.0.0

Manual upload

Via ZIP upload

Go to Plugins → Add New → Upload Plugin, select oforum.zip, click Install Now, then Activate.

Data model

Thread → room: post_meta key of_thread_room_id. Reply → thread: of_reply_thread_id. Reply hierarchy (quoting): of_reply_parent_id.

Room properties

PHP API

PHP// Create a room
$room_id = OF_Rooms::create([
    'name'       => 'General Discussion',
    'icon'       => '💬',
    'color'      => '#38BDF8',
    'visibility' => 'public',
]);

// Query rooms
$rooms = OF_Rooms::get_all();               // All rooms (flat)
$rooms = OF_Rooms::get_all(false);          // Top-level only
$room  = OF_Rooms::get($room_id);           // By ID
$room  = OF_Rooms::get_by_slug('general-discussion');

// Visibility check
$can   = OF_Rooms::user_can_view($room_id, $user_id);

Thread meta keys

Querying threads

PHP$result = OF_Query::get_threads([
    'room_id'      => 5,
    'thread_type'  => 'question',
    'sticky_first' => true,
    'page'         => 1,
    'per_page'     => 25,
    'orderby'      => 'last_reply',  // last_reply | date | reply_count
]);

// Returns:
// [
//   'threads'   => [...],  // array of formatted thread arrays
//   'total'     => 42,
//   'max_pages' => 2,
// ]

Admin thread actions (AJAX)

All admin thread actions use the of_thread_action AJAX endpoint with an action_type param:

Reply meta keys

Accepted solutions

Thread authors and moderators can mark a reply as the accepted answer on Question threads. This sets of_reply_is_solution = 1 on the reply, and of_thread_solved = 1 + of_thread_solution_id on the thread. The solution reply is pinned above pagination with a green ✓ Accepted Answer badge.

Edit window

Users can edit their own replies within a configurable window (default: 30 minutes). After the window, only moderators can edit. Edited replies show (edited) next to the timestamp. Set to 0 in Settings to disable editing entirely.

Reply quoting

Clicking Quote stores the reply ID in #of-quoted-reply-id and prefills the form with a quote preview. The of_reply_parent_id is set on submission to maintain the reply hierarchy.

PHP API

PHP// Toggle a reaction (returns action + updated counts)
$result = OF_Reactions::toggle($user_id, $reply_id, '👍');
// ['action' => 'added'|'removed', 'counts' => ['👍' => 3, '❤️' => 1]]

// Get counts for a reply
$counts = OF_Reactions::get_counts($reply_id);

// Get emojis a user has reacted with
$user_reactions = OF_Reactions::get_user_reactions($user_id, $reply_id);

REST API

HTTPPOST /wp-json/oforum/v1/reactions
{ "reply_id": 42, "emoji": "👍" }

// Response:
{ "action": "added", "counts": { "👍": 3, "❤️": 1 } }

Subscription types & frequencies

PHPOF_Notify::subscribe($user_id, 'thread', $thread_id, 'immediate');
OF_Notify::unsubscribe($user_id, 'thread', $thread_id);
$is_subbed = OF_Notify::is_subscribed($user_id, 'thread', $thread_id);

In-forum notification types

PHPOF_Notify::create($user_id, [
    'type'      => 'mention',
    'post_id'   => $post_id,
    'from_user' => $author_id,
    'message'   => 'John Doe mentioned you.',
    'url'       => get_permalink($post_id) . '#reply-' . $reply_id,
]);

@mentions & polling

On reply submit, OF_Notify::parse_mentions() scans for @username patterns, resolves users by user_login and user_slug, and fires immediate in-forum notifications. The notification bell polls for unread counts every 60 seconds via AJAX (of_get_notifications).

Permission levels

PHPOF_Permissions::set_level($user_id, OF_Permissions::LEVEL_MOD);

Report queue

Users click Report on any reply to file a report. Moderators see the queue at Moderation → Flagged Reports with four actions:

Shadow ban

Shadow-banned users' future posts are only visible to themselves and moderators. Other users see nothing, so the banned user has no idea they're banned.

PHPOF_Moderation::shadow_ban_user($user_id, $mod_user_id);
OF_Moderation::unshadow_ban_user($user_id, $mod_user_id);
$is_banned = OF_Moderation::is_shadow_banned($user_id);

IP ban

PHP// Permanent ban
OF_Moderation::ban_ip('192.168.1.1', $mod_id, 'Spam', null);

// Timed ban: expires 2026-12-31
OF_Moderation::ban_ip('192.168.1.1', $mod_id, 'Abuse', '2026-12-31 23:59:59');

OF_Moderation::unban_ip('192.168.1.1', $mod_id);
$is_banned = OF_Permissions::is_ip_banned('192.168.1.1');

IP bans block the post/reply REST API endpoints. The auto-moderation hook also checks IPs on reply submission.

Audit log

Every moderation action is logged to wp_of_mod_log. View at Moderation → Audit Log.

PHP$log = OF_Moderation::get_log(50); // Last 50 entries

Trust gates

PHP API

PHP$level         = OF_Trust::get_level($user_id);        // int 0–3
$label         = OF_Trust::get_label($level);           // "New Member", "Member", …
OF_Trust::recalculate($user_id);                        // Force recalculate
$needs_approval = OF_Trust::requires_approval($user_id); // bool

PHP API

PHP$result = OF_Search::search('doctrine of grace', [
    'room_id'     => 5,
    'thread_type' => 'discussion',
    'author_id'   => 0,
    'date_from'   => '2025-01-01',
    'date_to'     => '2025-12-31',
    'page'        => 1,
    'per_page'    => 20,
]);

// Returns:
// [
//   'results'   => [['id', 'title', 'excerpt', 'url', 'date', 'author', 'type'], ...],
//   'total'     => 42,
//   'max_pages' => 3,
// ]

REST API & live search

HTTPGET /wp-json/oforum/v1/search?q=keyword&room_id=5&page=1

The forum index and room pages include a live search box (#of-search-input) that calls the REST API after a 300ms debounce and renders results in #of-search-results.

Breadcrumbs

PHPOF_SEO::render_breadcrumbs();             // Forum index
OF_SEO::render_breadcrumbs($room);        // Room page
OF_SEO::render_breadcrumbs($room, $thread); // Thread page

Renders BreadcrumbList Schema.org markup on all forum pages.

DiscussionForumPosting schema

On thread pages, OF_SEO::inject_schema() outputs a <script type="application/ld+json"> block with DiscussionForumPosting structured data: headline, author, date, reply count, and first 5 reply comments.

Page titles & sitemap

The plugin filters document_title_parts and wp_title for proper titles: Thread Title · Site Name and Room Name · Forum · Site Name.

OForum integrates with Yoast SEO (wpseo_sitemap_index_links) and The SEO Framework (the_seo_framework_sitemap_urls) to include the 200 most recently modified published thread URLs in the sitemap.

Rooms

Threads

JSON// Create thread body
{
  "title":   "My thread title",
  "content": "<p>Thread content</p>",
  "type":    "discussion",
  "room_id": 5
}

Replies

JSON// Create reply body
{
  "thread_id": 42,
  "parent_id": 0,
  "content":   "<p>My reply</p>"
}

Reactions & search

URL routing

Frontend JS globals

The OF global object is available on all forum pages:

JSwindow.OF = {
  ajaxUrl:   'https://site.com/wp-admin/admin-ajax.php',
  restUrl:   'https://site.com/wp-json/oforum/v1/',
  nonce:     '...',       // WP REST nonce
  ajaxNonce: '...',       // AJAX nonce
  loggedIn:  1,           // 1 or 0
  userId:    42,
  loginUrl:  '...',
  forumUrl:  '/forum/',
  perPage:   25,
};

window.OF_emojis = ['👍', '❤️', '😂', '🔥', '💡']; // from settings

Filters

PHP// Modify allowed reaction emojis
add_filter('of_allowed_emojis', function($emojis) {
    return ['👍', '❤️', '🎉', '🤔', '👀'];
});

// Modify room visibility check
add_filter('of_room_can_view', function($can, $room_id, $user_id) {
    // Custom logic; return bool
    return $can;
}, 10, 3);

// Modify reply content before save
add_filter('of_reply_content', function($content, $user_id) {
    // e.g. strip disallowed HTML
    return $content;
}, 10, 2);

Actions

PHP// Fired after a thread is created
add_action('of_thread_created', function($thread_id, $room_id, $author_id) {
    // e.g. post to Slack channel
}, 10, 3);

// Fired after a reply is created and published
add_action('of_reply_created', function($reply_id, $thread_id, $author_id) {
    // e.g. award points in a gamification plugin
}, 10, 3);

// Fired after trust level changes (4 args: user_id, new_level, post_count, solved_count)
add_action('oforum_trust_level_updated', function($user_id, $level, $posts, $solved) {
    // e.g. award badge in OEngage when a user reaches Leader
}, 10, 4);

// Fired when a moderator marks a reply as the accepted solution
add_action('oforum_solution_marked', function($thread_id, $reply_id, $solver_uid) {
    // e.g. notify the reply author + bump their reputation
}, 10, 3);

// Fired by OF_Notify when a notification gets pushed (in-forum or email)
add_action('oforum_push_event', function($user_id, $data) {
    // e.g. forward to your real-time push provider
}, 10, 2);

of_reactions

Unique constraint on (user_id, reply_id, emoji): one reaction per emoji per user per reply.

of_subscriptions

of_notifications

of_reports

of_ip_bans & of_mod_log

of_votes

Unique constraint on (user_id, post_id, post_type): one vote per user per post.

of_bookmarks

Unique constraint on (user_id, thread_id): a thread can be bookmarked at most once per user.

of_room_members

Backs invite-only rooms. Public rooms ignore this table; visibility is gated by of_room_visibility meta.

of_thread_stats

Performance cache so room listings and thread cards do not re-aggregate post meta on every render.