wpDiscuz

https://github.com/wp-plugins/wpdiscuz
Admin
wpDiscuz is an interactive AJAX-based WordPress comment system with live updates, voting, nested...
Tokens:15,830
Snippets:127
Trust Score:8.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Callback: onSlideBefore Example

Source: https://github.com/wp-plugins/wpdiscuz/blob/master/bxslider/readme.md

This callback executes just before a slide transition occurs. It provides the destination slide element, the previous slide index, and the new slide index.

```javascript
options: function($slideElement, oldIndex, newIndex){ // your code here }
```

--------------------------------

### Callback: onSliderLoad Example

Source: https://github.com/wp-plugins/wpdiscuz/blob/master/bxslider/readme.md

This callback executes once the slider has finished loading. It receives the index of the current slide as an argument.

```javascript
options: function(currentIndex){ // your code here }
```

--------------------------------

### Utility Functions with WC_Helper

Source: https://context7.com/wp-plugins/wpdiscuz/llms.txt

Utilize shared utility methods for date differences, checking comment status, resolving comment ancestors, making text clickable, getting client IP, sorting comments, and retrieving user avatars.

```php
global $wc_core;
$helper = $wc_core->wc_helper;

// --- Human-readable relative date (e.g. "2 hours 15 minutes ago") ---
$relative = $helper->dateDiff(time(), strtotime($comment->comment_date_gmt), 2);

// --- Check if a comment was posted today ---
$today = WC_Helper::is_posted_today($comment); // bool

// --- Check if comment is still within editable window ---
$editable = $helper->is_comment_editable($comment); // bool

// --- Resolve root ancestor of a comment (recursively) ---
$root = WC_Helper::get_comment_root_id($comment_id);

// --- Convert plain text URLs/emails/images to HTML links ---
$html = $helper->make_clickable('Visit https://example.com or email me@example.com');

// --- Get real client IP (proxy-aware) ---
$ip = WC_Helper::get_real_ip_addr();

// --- Sort parent comments ascending by ID ---
$sorted = $helper->wc_sort_parent_comments($wc_parent_comments); // array of WP_Comment

// --- Get user avatar (with social login plugin support) ---
$avatar_html = $helper->get_comment_author_avatar($comment); // returns get_avatar() HTML (48px)
```

--------------------------------

### Handle Subscription Confirmation and Unsubscribe URLs

Source: https://context7.com/wp-plugins/wpdiscuz/llms.txt

This code snippet from form.php processes GET parameters to confirm subscriptions or unsubscribe users. It requires the wc_core object to be available.

```php
if (isset($_GET['wpdiscuzSubscribeID']) && isset($_GET['key'])) {
    $wc_core->wc_unsubscribe($_GET['wpdiscuzSubscribeID'], $_GET['key']);
    // Shows: "You've successfully unsubscribed."
}

if (isset($_GET['wpdiscuzConfirmID']) && isset($_GET['wpdiscuzConfirmKey'])) {
    $wc_core->wc_db_helper->wc_notification_confirm(
        $_GET['wpdiscuzConfirmID'],
        $_GET['wpdiscuzConfirmKey']
    );
    // Shows: "You've successfully confirmed your subscription."
}
```

--------------------------------

### Start Auto Play

Source: https://github.com/wp-plugins/wpdiscuz/blob/master/bxslider/readme.md

Initiates the automatic sliding of the carousel. An optional argument `false` can be passed to prevent auto controls from updating.

```javascript
slider = $(".bxslider").bxSlider();
slider.startAuto();
```

--------------------------------

### Render Comment HTML with WC_Comment_Template_Builder

Source: https://context7.com/wp-plugins/wpdiscuz/llms.txt

Use get_comment_template() to build the complete HTML for a single comment. This includes avatar, author info, content, voting, reply form, and sharing options. It also provides methods to get author names and unique DOM identifiers.

```php
global $wc_core;
$builder = $wc_core->comment_tpl_builder;

// Render a single comment
$comment = get_comment(157);
$depth   = 1;
$html    = $builder->get_comment_template($comment, null, $depth);
// $html is a complete <div class="wc-comment ..."> block with:
//   - Avatar + author role label (Guest/Member/Author/Admin)
//   - Author name (linked to profile if BuddyPress/UserPro/UM/UsersUltra is active)
//   - Relative or absolute post date
//   - Sanitized, linkified comment content
//   - Vote count + up/down thumbs (if voting enabled)
//   - Reply link + inline reply form (if replies allowed)
//   - Share buttons for Facebook/Twitter/Google+/VK/Odnoklassniki (if sharing enabled)
//   - Edit/Save/Cancel inline edit controls (if within editable time window)
//   - Toggle show/hide replies button (if comment has children)

// Get author display name (handles UM, logged-in WP users, guests)
$name = $builder->get_author_name($comment);
// Logged-in WP user: display_name or user_login
// Ultimate Member: um_user('display_name')
// Guest: comment_author or "Anonymous"

// Get unique DOM identifier for a comment's elements
$uid = $builder->get_unique_id($comment);
// Returns "{post_id}_{comment_id}", e.g. "42_157"
// Used as suffix for IDs like wc-comm-42_157, vote-count-42_157, etc.

// WordPress callback integration (used by wp_list_comments)
add_filter('comments_template', function($file) {
    // wc.php hooks this to replace the default template with comment-form/form.php
    return plugin_dir_path(__FILE__) . 'comment-form/form.php';
});
```

--------------------------------

### Get Total Slide Count

Source: https://github.com/wp-plugins/wpdiscuz/blob/master/bxslider/readme.md

Returns the total number of slides present in the slider instance. This can be used for pagination or progress indicators.

```javascript
slider = $(".bxslider").bxSlider();
var slideQty = slider.getSlideCount();
```

--------------------------------

### Get Current Slide Index

Source: https://github.com/wp-plugins/wpdiscuz/blob/master/bxslider/readme.md

Retrieves the index of the currently active slide. This is useful for tracking the slider's state.

```javascript
slider = $(".bxslider").bxSlider();
var current = slider.getCurrentSlide();
```

--------------------------------

### Get and Save Editable Comment

Source: https://context7.com/wp-plugins/wpdiscuz/llms.txt

Allows logged-in users to fetch and edit their own comments within a configurable time limit. Saving validates ownership and time, then updates the comment.

```APIDOC
## AJAX: Get and Save Editable Comment

### Description
Allows logged-in users to edit their own comments within a configurable time window (`wc_comment_editable_time`, default 900 seconds). Fetching retrieves raw comment content; saving validates ownership and time window, then updates the comment.

### Method
POST

### Endpoint
`wc_ajax_obj.url`

### Operations
#### 1. Fetch Editable Comment Content

##### Parameters
- **action** (string) - Required - `wc_get_editable_comment_content`
- **comment_id** (integer) - Required - The ID of the comment to fetch.

##### Response
- **code** (integer) - 1 for success.
- **message** (string) - Raw comment text for editing.
- **phrase_message** (string) - Error message if editing is not possible.

#### 2. Save Edited Comment

##### Parameters
- **action** (string) - Required - `wc_save_edited_comment`
- **comment_id** (integer) - Required - The ID of the comment to save.
- **comment_content** (string) - Required - The updated comment text.

##### Response
- **code** (integer) - 1 for success, -2 if no changes, other negative for errors.
- **message** (string) - The rendered (clickable links, allowed HTML) new content if successful.
- **phrase_message** (string) - Error message if saving fails.

### Request Example
```javascript
// Step 1: Fetch existing comment content for editing
jQuery.post(wc_ajax_obj.url, {
    action:     'wc_get_editable_comment_content',
    comment_id: 157
}, function(response) {
    var res = JSON.parse(response);
    if (res.code === 1) {
        jQuery('#edit-textarea').val(res.message);
    } else {
        alert(res.phrase_message);
    }
});

// Step 2: Save the edited comment
jQuery.post(wc_ajax_obj.url, {
    action:          'wc_save_edited_comment',
    comment_id:      157,
    comment_content: 'Updated comment text with <b>formatting</b>.'
}, function(response) {
    var res = JSON.parse(response);
    if (res.code === 1) {
        jQuery('#comment-157 .wc-comment-text').html(res.message);
    } else if (res.code === -2) {
        alert(res.phrase_message);
    } else {
        alert(res.phrase_message);
    }
});
```
```

--------------------------------

### Plugin Activation - Create DB Tables

Source: https://context7.com/wp-plugins/wpdiscuz/llms.txt

This code snippet shows how to manually trigger the creation of database tables for wpDiscuz. It's typically handled automatically on plugin activation.

```php
// Plugin activation — creates DB tables
// Triggered automatically on activation via register_activation_hook
// Manual call if needed:
$wc_core->db_operations();
// Creates: {prefix}wc_users_voted, {prefix}wc_phrases, {prefix}wc_comments_subscription
```

--------------------------------

### Initialize bxSlider with Default Settings

Source: https://github.com/wp-plugins/wpdiscuz/blob/master/bxslider/readme.md

Initializes the bxSlider with default configuration. Ensure your HTML includes a container with the class 'bxslider'.

```javascript
slider = $(".bxslider").bxSlider();
```

--------------------------------

### Public Methods

Source: https://github.com/wp-plugins/wpdiscuz/blob/master/bxslider/readme.md

Public methods allow programmatic control over the bxSlider instance.

```APIDOC
## Public Methods

### goToSlide

Performs a slide transition to the supplied slide index (zero-based).

- **Example**:
  ```javascript
  slider = $(".bxslider").bxSlider();
  slider.goToSlide(3);
  ```

### goToNextSlide

Performs a "Next" slide transition.

- **Example**:
  ```javascript
  slider = $(".bxslider").bxSlider();
  slider.goToNextSlide();
  ```

### goToPrevSlide

Performs a "Prev" slide transition.

- **Example**:
  ```javascript
  slider = $(".bxslider").bxSlider();
  slider.goToPrevSlide();
  ```

### startAuto

Starts the auto show. Provide an argument `false` to prevent the auto controls from being updated.

- **Example**:
  ```javascript
  slider = $(".bxslider").bxSlider();
  slider.startAuto();
  ```

### stopAuto

Stops the auto show. Provide an argument `false` to prevent the auto controls from being updated.

- **Example**:
  ```javascript
  slider = $(".bxslider").bxSlider();
  slider.stopAuto();
  ```

### getCurrentSlide

Returns the current active slide.

- **Example**:
  ```javascript
  slider = $(".bxslider").bxSlider();
  var current = slider.getCurrentSlide();
  ```

### getSlideCount

Returns the total number of slides in the slider.

- **Example**:
  ```javascript
  slider = $(".bxslider").bxSlider();
  var slideQty = slider.getSlideCount();
  ```

### reloadSlider

Reload the slider. Useful when adding slides on the fly. Accepts an optional settings object. See <a href="/examples/reload-slider-settings">here</a> for an example.

- **Example**:
  ```javascript
  slider = $(".bxslider").bxSlider();
  slider.reloadSlider();
  ```

### destroySlider

Destroy the slider. This reverts all slider elements back to their original state (before calling the slider).

- **Example**:
  ```javascript
  slider = $(".bxslider").bxSlider();
  slider.destroySlider();
  ```
```

--------------------------------

### Access and Update Plugin Settings with WC_Options_Serialize

Source: https://context7.com/wp-plugins/wpdiscuz/llms.txt

Manage all plugin settings stored as a single serialized option. Access UI phrases (translatable strings) and programmatically update settings. Remember to call `update_options()` to persist changes.

```php
global $wc_core;
$opts = $wc_core->wc_options_serialized;

// --- Key display/behavior settings ---
$opts->wc_post_types;
$opts->wc_comment_list_order;
$opts->wc_comment_list_update_type;
$opts->wc_comment_list_update_timer;
$opts->wc_comment_editable_time;
$opts->wc_comment_count;
$opts->wc_comments_max_depth;

// --- Feature toggles (0=shown/enabled, 1=hidden/disabled) ---
$opts->wc_voting_buttons_show_hide;
$opts->wc_share_buttons_show_hide;
$opts->wc_captcha_show_hide;
$opts->wc_avatar_show_hide;
$opts->wc_user_must_be_registered;

// --- Color customization ---
$opts->wc_form_bg_color;
$opts->wc_comment_bg_color;
$opts->wc_reply_bg_color;
$opts->wc_comment_text_color;
$opts->wc_author_title_color;
$opts->wc_vote_reply_color;
$opts->wc_custom_css;

// --- Programmatically update settings ---
$opts->wc_comment_count = 10;
$opts->wc_comment_list_order = 'asc';
$opts->update_options(); // persists to wp_options as serialized data

// --- Phrase access ---
echo $opts->wc_phrases['wc_submit_text'];
echo $opts->wc_phrases['wc_reply_text'];
echo $opts->wc_phrases['wc_vote_up'];
echo $opts->wc_phrases['wc_held_for_moderate'];

// Reload phrases from DB (respects wc_is_use_po_mo setting)
$opts->init_phrases_on_load();
```

--------------------------------

### Configuration Options

Source: https://github.com/wp-plugins/wpdiscuz/blob/master/bxslider/readme.md

These options configure the behavior and appearance of the bxSlider carousel.

```APIDOC
## Configuration Options

### minSlides

The minimum number of slides to be shown. Slides will be sized down if carousel becomes smaller than the original size.

- **Default**: 1
- **Options**: integer

### maxSlides

The maximum number of slides to be shown. Slides will be sized up if carousel becomes larger than the original size.

- **Default**: 1
- **Options**: integer

### moveSlides

The number of slides to move on transition. This value must be `>= minSlides`, and `<= maxSlides`. If zero (default), the number of fully-visible slides will be used.

- **Default**: 0
- **Options**: integer

### slideWidth

The width of each slide. This setting is required for all horizontal carousels!

- **Default**: 0
- **Options**: integer
```

--------------------------------

### WC_CSS

Source: https://context7.com/wp-plugins/wpdiscuz/llms.txt

This class handles dynamic style injection by outputting an inline `<style>` block in the `<head>` of singular pages. It renders all color and appearance settings configured via `WC_Options_Serialize` as CSS variables, allowing for easy customization of the comment section's look and feel.

```APIDOC
## WC_CSS — Dynamic Style Injection

`WC_CSS::init_styles()` is hooked to `wp_head` and outputs an inline `<style>` block on singular pages, rendering all color and appearance settings from `WC_Options_Serialize` as CSS variables.

```php
// This runs automatically via the wp_head action on singular posts/pages.
// To customize styles, update options via WC_Options_Serialize:

global $wc_core;
$opts = $wc_core->wc_options_serialized;

$opts->wc_form_bg_color              = '#f0f4ff';  // comment form background
$opts->wc_comment_bg_color           = '#ffffff';  // comment bubble background
$opts->wc_reply_bg_color             = '#f5f5f5';  // nested reply background
$opts->wc_comment_text_color         = '#333333';  // comment body text
$opts->wc_author_title_color         = '#0073aa';  // author name + label badge
$opts->wc_vote_reply_color           = '#888888';  // vote/reply/share link color
$opts->wc_input_border_color         = '#cccccc';  // textarea/input border
$opts->wc_new_loaded_comment_bg_color = 'rgb(255,255,200)'; // highlight for newly loaded
$opts->wc_comment_text_size          = '15px';
$opts->wc_custom_css                 = '.comments-area { max-width: 800px; margin: 0 auto; }';

$opts->update_options();

// Generated <style> output (abbreviated):
// #wpcomm .wc-form-wrapper { background: #f0f4ff; }
// #wpcomm .wc-comment .wc-comment-right { background: #ffffff; }
// #wpcomm .wc-reply .wc-comment-right { background: #f5f5f5; }
// #wpcomm .wc-comment-text { font-size: 15px; color: #333333; }
// .comments-area { max-width: 800px; margin: 0 auto; }
```
```

--------------------------------

### Inject Dynamic Styles with WC_CSS

Source: https://context7.com/wp-plugins/wpdiscuz/llms.txt

WC_CSS::init_styles() outputs an inline <style> block in the wp_head, rendering appearance settings as CSS variables. Customize styles by updating options via WC_Options_Serialize.

```php
// This runs automatically via the wp_head action on singular posts/pages.
// To customize styles, update options via WC_Options_Serialize:

global $wc_core;
$opts = $wc_core->wc_options_serialized;

$opts->wc_form_bg_color              = '#f0f4ff';  // comment form background
$opts->wc_comment_bg_color           = '#ffffff';  // comment bubble background
$opts->wc_reply_bg_color             = '#f5f5f5';  // nested reply background
$opts->wc_comment_text_color         = '#333333';  // comment body text
$opts->wc_author_title_color         = '#0073aa';  // author name + label badge
$opts->wc_vote_reply_color           = '#888888';  // vote/reply/share link color
$opts->wc_input_border_color         = '#cccccc';  // textarea/input border
$opts->wc_new_loaded_comment_bg_color = 'rgb(255,255,200)'; // highlight for newly loaded
$opts->wc_comment_text_size          = '15px';
$opts->wc_custom_css                 = '.comments-area { max-width: 800px; margin: 0 auto; }';

$opts->update_options();

// Generated <style> output (abbreviated):
// #wpcomm .wc-form-wrapper { background: #f0f4ff; }
// #wpcomm .wc-comment .wc-comment-right { background: #ffffff; }
// #wpcomm .wc-reply .wc-comment-right { background: #f5f5f5; }
// #wpcomm .wc-comment-text { font-size: 15px; color: #333333; }
// .comments-area { max-width: 800px; margin: 0 auto; }
```

--------------------------------

### Include bxSlider Files

Source: https://github.com/wp-plugins/wpdiscuz/blob/master/bxslider/readme.md

Link the jQuery library, bxSlider JavaScript, and bxSlider CSS files in your HTML. Ensure jQuery is loaded before bxSlider.

```html
<!-- jQuery library (served from Google) -->
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.8.2/jquery.min.js"></script>
<!-- bxSlider Javascript file -->
<script src="/js/jquery.bxslider.min.js"></script>
<!-- bxSlider CSS file -->
<link href="/lib/jquery.bxslider.css" rel="stylesheet" />
```

--------------------------------

### WC_DB_Helper Class

Source: https://context7.com/wp-plugins/wpdiscuz/llms.txt

Provides methods for direct database interactions including voting, phrase storage, email subscriptions, and comment queries.

```APIDOC
## WC_DB_Helper — Database Operations

`WC_DB_Helper` wraps all direct database interactions: voting records, phrase storage, email subscriptions, and comment queries. It uses WordPress `$wpdb` with prepared statements throughout.

### Instantiation
```php
// Instantiation (done automatically by WC_Core)
$db = new WC_DB_Helper();
```

### Voting

#### Record a new vote
```php
$db->add_vote_type('user_123', 157, 1);   // user_id|IP, comment_id, vote_type (+1 or -1)
```

#### Update an existing vote (e.g., change from +1 to 0)
```php
$db->update_vote_type('user_123', 157, 0);
```

#### Check if user has voted (returns vote_type string or null)
```php
$existing_vote = $db->is_user_voted('user_123', 157);
// Returns '1', '-1', '0', or null
```

### Comment queries

#### Count approved comments on a post
```php
$count = $db->get_comments_count(42);          // all comments on post 42
$count = $db->get_comments_count(42, 'jane@example.com', '2024-01-01 00:00:00'); // filtered
```

#### Get count of top-level (parent) comments
```php
$parent_count = $db->get_post_parent_comments_count(42);
```

#### Get the highest approved comment ID for a post
```php
$last_id = $db->get_last_comment_id_by_post_id(42); // returns int or 0
```

#### Get new comments since a known comment ID
```php
$new_comments = $db->wc_get_new_comments(42, 200, 'jane@example.com');
// Returns array of ['comment_id' => int, 'comment_parent' => int]
```

#### Get visible parent comment IDs up to a limit (for live update diffing)
```php
$visible_ids = $db->wc_get_visible_parent_comment_ids(42, 10);
```

### Email subscriptions

#### Add a subscription (is_all: 1=post, 2=all_comments, 3=single comment reply)
```php
$insert_id = $db->wc_add_email_notification($subscribtion_id, $post_id, 'jane@example.com', 1);
```

#### Check if subscription exists
```php
$has_sub = $db->wc_has_post_notification(42, 'jane@example.com');    // bool-like int
$has_sub = $db->wc_has_comment_notification(42, 157, 'jane@example.com');
```

#### Confirm a subscription via email link
```php
$db->wc_notification_confirm($subscribe_id, $activation_key);
```

#### Unsubscribe
```php
$db->wc_unsubscribe($subscription_id, $activation_key);
```

#### Generate confirm/unsubscribe links (returns full URL with query params)
```php
$confirm_url     = $db->wc_confirm_link($subscribe_id);
$unsubscribe_url = $db->wc_unsubscribe_link($post_or_comment_id, 'jane@example.com', 'post');
```

### Phrase management

#### Retrieve all custom phrases from DB
```php
$phrases = $db->get_phrases();
// Returns assoc array, e.g. ['wc_leave_a_reply_text' => 'Leave a Reply', ...]
```

#### Upsert phrases
```php
$db->update_phrases(['wc_submit_text' => 'Send Comment', 'wc_reply_text' => 'Respond']);
```

#### Check phrase existence
```php
$exists = $db->is_phrase_exists('wc_submit_text'); // returns phrase_key string or null
```

### Schema management (runs on plugin activation)

#### Create tables
```php
$db->create_tables();                     // creates wc_users_voted, wc_phrases, wc_comments_subscription
$db->wc_create_email_notification_table(); // idempotent; also migrates legacy tables
```
```

--------------------------------

### Initialize bxSlider

Source: https://github.com/wp-plugins/wpdiscuz/blob/master/bxslider/readme.md

Call the `.bxSlider()` method on your slider element within a `$(document).ready()` function to initialize the slider. This ensures the DOM is fully loaded before the plugin runs.

```javascript
$(document).ready(function(){
  $('.bxslider').bxSlider();
});
```

--------------------------------

### WC_Core::wpdiscuz_comment_redirect()

Source: https://context7.com/wp-plugins/wpdiscuz/llms.txt

AJAX handler for redirecting first-time commenters to a configured page after a new comment is posted.

```APIDOC
## AJAX: First-Commenter Redirect

`WC_Core::wpdiscuz_comment_redirect()` — AJAX handler for `wpdiscuz_comment_redirect`.

After a new comment is posted, checks whether the commenter is a first-time commenter. If so, and if a redirect page is configured in settings (`wpdiscuz_redirect_page`), returns a redirect URL.

### Request Example
```javascript
jQuery.post(wc_ajax_obj.url, {
    action:           'wpdiscuz_comment_redirect',
    wc_new_comment_id: 301   // ID returned from comment submission
}, function(response) {
    var res = JSON.parse(response);
    if (res.code === 1 && res.redirect_to) {
        // First-time commenter — redirect to configured "thank you" page
        window.location.href = res.redirect_to;
    }
    // If res is empty object {}, no redirect needed
});
```

### Response Example
```json
{
  "code": 1,
  "redirect_to": "http://example.com/thank-you/"
}
```
```

--------------------------------

### WC_DB_Helper: Database Operations

Source: https://context7.com/wp-plugins/wpdiscuz/llms.txt

The WC_DB_Helper class provides methods for interacting with the wpDiscuz database. It handles voting records, comment queries, email subscriptions, and phrase management using WordPress's $wpdb object with prepared statements.

```php
$db = new WC_DB_Helper();
```

```php
$db->add_vote_type('user_123', 157, 1);   // user_id|IP, comment_id, vote_type (+1 or -1)
```

```php
$db->update_vote_type('user_123', 157, 0);
```

```php
$existing_vote = $db->is_user_voted('user_123', 157);
```

```php
$count = $db->get_comments_count(42);          // all comments on post 42
```

```php
$count = $db->get_comments_count(42, 'jane@example.com', '2024-01-01 00:00:00'); // filtered
```

```php
$parent_count = $db->get_post_parent_comments_count(42);
```

```php
$last_id = $db->get_last_comment_id_by_post_id(42); // returns int or 0
```

```php
$new_comments = $db->wc_get_new_comments(42, 200, 'jane@example.com');
// Returns array of ['comment_id' => int, 'comment_parent' => int]
```

```php
$visible_ids = $db->wc_get_visible_parent_comment_ids(42, 10);
```

```php
$insert_id = $db->wc_add_email_notification($subscribtion_id, $post_id, 'jane@example.com', 1);
```

```php
$has_sub = $db->wc_has_post_notification(42, 'jane@example.com');    // bool-like int
```

```php
$has_sub = $db->wc_has_comment_notification(42, 157, 'jane@example.com');
```

```php
$db->wc_notification_confirm($subscribe_id, $activation_key);
```

```php
$db->wc_unsubscribe($subscription_id, $activation_key);
```

```php
$confirm_url     = $db->wc_confirm_link($subscribe_id);
```

```php
$unsubscribe_url = $db->wc_unsubscribe_link($post_or_comment_id, 'jane@example.com', 'post');
```

```php
$phrases = $db->get_phrases();
// Returns assoc array, e.g. ['wc_leave_a_reply_text' => 'Leave a Reply', ...]
```

```php
$db->update_phrases(['wc_submit_text' => 'Send Comment', 'wc_reply_text' => 'Respond']);
```

```php
$exists = $db->is_phrase_exists('wc_submit_text'); // returns phrase_key string or null
```

```php
$db->create_tables();                     // creates wc_users_voted, wc_phrases, wc_comments_subscription
```

```php
$db->wc_create_email_notification_table(); // idempotent; also migrates legacy tables
```

--------------------------------

### Basic bxSlider HTML Markup

Source: https://github.com/wp-plugins/wpdiscuz/blob/master/bxslider/readme.md

Structure your content within a `<ul>` with the class `bxslider`, where each `<li>` represents a slide. Slides can contain images, video, or any HTML.

```html
<ul class="bxslider">
  <li><img src="/images/pic1.jpg" /></li>
  <li><img src="/images/pic2.jpg" /></li>
  <li><img src="/images/pic3.jpg" /></li>
  <li><img src="/images/pic4.jpg" /></li>
</ul>
```

--------------------------------

### Load More Comments with AJAX

Source: https://context7.com/wp-plugins/wpdiscuz/llms.txt

Fetches the next page of comments. If `wc_load_all_comments` is enabled, it loads all remaining comments.

```javascript
jQuery.post(wc_ajax_obj.url, {
    action:                     'wc_load_more_comments',
    wc_post_id:                 42,
    comments_offset:            2,     // next page (2 = second batch)
    wc_last_comment_id:         200,
    wc_curr_user_comment_count: 0
}, function(response) {
    var res = JSON.parse(response);
    // res.code:              1 = success
    // res.message:           rendered HTML of comments for this page
    // res.wc_last_comment_id: updated last known comment ID

    if (res.code === 1) {
        jQuery('.wc-thread-wrapper').html(res.message);
    }
});
```

--------------------------------

### Load More Comments

Source: https://context7.com/wp-plugins/wpdiscuz/llms.txt

Fetches and returns the next page of comments. If configured, it can load all remaining comments at once.

```APIDOC
## AJAX: Load More Comments

### Description
Returns the next page of comments (offset-based pagination). If `wc_load_all_comments` is enabled in settings, loads all remaining comments at once.

### Method
POST

### Endpoint
`wc_ajax_obj.url`

### Parameters
#### Query Parameters
- **action** (string) - Required - `wc_load_more_comments`
- **wc_post_id** (integer) - Required - The ID of the post to load comments for.
- **comments_offset** (integer) - Required - The page number or offset for comments to load (e.g., 2 for the second batch).
- **wc_last_comment_id** (integer) - Required - The last known comment ID.
- **wc_curr_user_comment_count** (integer) - Required - The current user's comment count.

### Response
#### Success Response (200)
- **code** (integer) - 1 for success.
- **message** (string) - Rendered HTML of comments for the requested page.
- **wc_last_comment_id** (integer) - The updated last known comment ID.

### Request Example
```javascript
jQuery.post(wc_ajax_obj.url, {
    action:                     'wc_load_more_comments',
    wc_post_id:                 42,
    comments_offset:            2,
    wc_last_comment_id:         200,
    wc_curr_user_comment_count: 0
}, function(response) {
    var res = JSON.parse(response);
    if (res.code === 1) {
        jQuery('.wc-thread-wrapper').html(res.message);
    }
});
```
```

--------------------------------

### Send Subscription Confirmation Email

Source: https://context7.com/wp-plugins/wpdiscuz/llms.txt

This function is called internally after a comment is posted to send a subscription confirmation email. It requires the $wc_core object and relevant IDs.

```php
$wc_core->wc_confirm_email_sender(
    $subscrib_id,       // ID in wc_comments_subscription table
    'jane@example.com',
    $post_id,
    $new_comment_id,
    'post'              // 'post' | 'reply' | 'all_comment'
);
// Sends HTML email with Confirm and Ignore Subscription links
```

--------------------------------

### WC_Comment_Template_Builder

Source: https://context7.com/wp-plugins/wpdiscuz/llms.txt

This class is responsible for building the complete HTML for a single comment. It includes rendering the avatar, author information, comment content, voting buttons, reply form, and share buttons. It is used for both initial page loads and dynamic updates via AJAX.

```APIDOC
## WC_Comment_Template_Builder — Render Comment HTML

`WC_Comment_Template_Builder::get_comment_template()` builds the full HTML for a single comment, including avatar, author info, content, vote buttons, reply form, and share buttons. It is used both for initial page render (via `wc_comment_callback`) and dynamically after AJAX comment submission.

```php
global $wc_core;
$builder = $wc_core->comment_tpl_builder;

// Render a single comment
$comment = get_comment(157);
$depth   = 1;
$html    = $builder->get_comment_template($comment, null, $depth);
// $html is a complete <div class="wc-comment ..."> block with:
//   - Avatar + author role label (Guest/Member/Author/Admin)
//   - Author name (linked to profile if BuddyPress/UserPro/UM/UsersUltra is active)
//   - Relative or absolute post date
//   - Sanitized, linkified comment content
//   - Vote count + up/down thumbs (if voting enabled)
//   - Reply link + inline reply form (if replies allowed)
//   - Share buttons for Facebook/Twitter/Google+/VK/Odnoklassniki (if sharing enabled)
//   - Edit/Save/Cancel inline edit controls (if within editable time window)
//   - Toggle show/hide replies button (if comment has children)

// Get author display name (handles UM, logged-in WP users, guests)
$name = $builder->get_author_name($comment);
// Logged-in WP user: display_name or user_login
// Ultimate Member: um_user('display_name')
// Guest: comment_author or "Anonymous"

// Get unique DOM identifier for a comment's elements
$uid = $builder->get_unique_id($comment);
// Returns "{post_id}_{comment_id}", e.g. "42_157"
// Used as suffix for IDs like wc-comm-42_157, vote-count-42_157, etc.

// WordPress callback integration (used by wp_list_comments)
add_filter('comments_template', function($file) {
    // wc.php hooks this to replace the default template with comment-form/form.php
    return plugin_dir_path(__FILE__) . 'comment-form/form.php';
});
```
```

--------------------------------

### Go to Next Slide

Source: https://github.com/wp-plugins/wpdiscuz/blob/master/bxslider/readme.md

Triggers a transition to the next slide in the sequence. This is commonly used with navigation controls.

```javascript
slider = $(".bxslider").bxSlider();
slider.goToNextSlide();
```

--------------------------------

### Go to Previous Slide

Source: https://github.com/wp-plugins/wpdiscuz/blob/master/bxslider/readme.md

Triggers a transition to the previous slide in the sequence. This is commonly used with navigation controls.

```javascript
slider = $(".bxslider").bxSlider();
slider.goToPrevSlide();
```

--------------------------------

### Callbacks

Source: https://github.com/wp-plugins/wpdiscuz/blob/master/bxslider/readme.md

Callbacks are functions that execute at specific points in the slider's lifecycle.

```APIDOC
## Callbacks

### onSliderLoad

Executes immediately after the slider is fully loaded.

- **Default**: `function(){}`
- **Options**: `function(currentIndex){ // your code here }`
- **Arguments**:
  - `currentIndex`: element index of the current slide

### onSliderResize

Executes immediately after the slider is resized.

- **Default**: `function(){}`
- **Options**: `function(currentIndex){ // your code here }`
- **Arguments**:
  - `currentIndex`: element index of the current slide

### onSlideBefore

Executes immediately before each slide transition.

- **Default**: `function(){}`
- **Options**: `function($slideElement, oldIndex, newIndex){ // your code here }`
- **Arguments**:
  - `$slideElement`: jQuery element of the destination element
  - `oldIndex`: element index of the previous slide (before the transition)
  - `newIndex`: element index of the destination slide (after the transition)

### onSlideAfter

Executes immediately after each slide transition. Function argument is the current slide element (when transition completes).

- **Default**: `function(){}`
- **Options**: `function($slideElement, oldIndex, newIndex){ // your code here }`
- **Arguments**:
  - `$slideElement`: jQuery element of the destination element
  - `oldIndex`: element index of the previous slide (before the transition)
  - `newIndex`: element index of the destination slide (after the transition)

### onSlideNext

Executes immediately before each "Next" slide transition. Function argument is the target (next) slide element.

- **Default**: `function(){}`
- **Options**: `function($slideElement, oldIndex, newIndex){ // your code here }`
- **Arguments**:
  - `$slideElement`: jQuery element of the destination element
  - `oldIndex`: element index of the previous slide (before the transition)
  - `newIndex`: element index of the destination slide (after the transition)

### onSlidePrev

Executes immediately before each "Prev" slide transition. Function argument is the target (prev) slide element.

- **Default**: `function(){}`
- **Options**: `function($slideElement, oldIndex, newIndex){ // your code here }`
- **Arguments**:
  - `$slideElement`: jQuery element of the destination element
  - `oldIndex`: element index of the previous slide (before the transition)
  - `newIndex`: element index of the destination slide (after the transition)
```

--------------------------------

### Handle First-Commenter Redirect via AJAX

Source: https://context7.com/wp-plugins/wpdiscuz/llms.txt

This JavaScript snippet sends an AJAX POST request to the server to check if a commenter is a first-time commenter. If they are, and a redirect page is configured, the browser will be redirected to that page.

```javascript
jQuery.post(wc_ajax_obj.url, {
    action:           'wpdiscuz_comment_redirect',
    wc_new_comment_id: 301   // ID returned from comment submission
}, function(response) {
    var res = JSON.parse(response);
    if (res.code === 1 && res.redirect_to) {
        // First-time commenter — redirect to configured "thank you" page
        window.location.href = res.redirect_to;
    }
    // If res is empty object {}, no redirect needed
});
```

--------------------------------

### Go to Specific Slide

Source: https://github.com/wp-plugins/wpdiscuz/blob/master/bxslider/readme.md

Navigates the slider to a specific slide using its zero-based index. This method is useful for programmatic control of the slider's position.

```javascript
slider = $(".bxslider").bxSlider();
slider.goToSlide(3);
```

--------------------------------

### Hook into Comment Form Areas

Source: https://context7.com/wp-plugins/wpdiscuz/llms.txt

Standard WordPress actions 'comment_form_top', 'comment_form_before', and 'comment_form_after' can be used to inject content into the comment form. Ensure the $wc_core object is accessible for other functionalities.

```php
add_action('comment_form_top', function() {
    // Output injected inside .wc_social_plugin_wrapper (e.g. social login buttons)
    echo '<div class="my-social-login">...</div>';
});

add_action('comment_form_before', function() {
    echo '<p class="comment-note">Please keep comments on-topic.</p>';
});

add_action('comment_form_after', function() {
    echo '<p class="comment-policy"><a href="/policy">Comment Policy</a></p>';
});

// --- Restrict post types that show the comment form ---
global $wc_core;
$wc_core->wc_options_serialized->wc_post_types = ['post', 'page', 'portfolio'];
$wc_core->wc_options_serialized->update_options();
```

--------------------------------

### AJAX: Submit a Comment

Source: https://context7.com/wp-plugins/wpdiscuz/llms.txt

Processes a new comment submission via AJAX. It validates input, creates the comment, handles subscriptions, and returns the rendered comment or an error message.

```APIDOC
## AJAX: Submit a Comment

`WC_Core::comment_submit_via_ajax()` — WordPress AJAX handler registered for `wc_comms_via_ajax`.

Processes a new comment submission. Validates CAPTCHA (if enabled), sanitizes all fields using `wp_kses`, creates the comment via `wp_new_comment`, handles email subscription registration, and returns JSON containing the rendered comment HTML or an error message.

### Method
POST

### Endpoint
`admin-ajax.php` (with `action: 'wc_comms_via_ajax'`) 

### Parameters
#### Request Body
- **action** (string) - Required - `wc_comms_via_ajax`
- **comment_post_ID** (integer) - Required - The ID of the post to which the comment belongs.
- **comment_parent** (integer) - Required - 0 for a top-level comment, or the parent comment ID for a reply.
- **comment_depth** (integer) - Required - The depth of the comment thread.
- **comment** (string) - Required - The content of the comment.
- **name** (string) - Optional - The name of the commenter (required if not logged in).
- **email** (string) - Optional - The email of the commenter (required if not logged in).
- **website** (string) - Optional - The website of the commenter.
- **captcha** (string) - Optional - The CAPTCHA code (required if CAPTCHA is enabled).
- **notification_type** (string) - Optional - Type of notification ('post', 'all_comment', 'reply', or '').

### Request Example
```javascript
jQuery.post(wc_ajax_obj.url, {
    action:             'wc_comms_via_ajax',
    comment_post_ID:    42,
    comment_parent:     0,
    comment_depth:      1,
    comment:            'Great article!',
    name:               'Jane Doe',
    email:              'jane@example.com',
    website:            'https://example.com',
    captcha:            'aB3xZ',
    notification_type:  'post'
}, function(response) {
    var res = JSON.parse(response);
    if (res.code === 1) {
        console.log('New comment HTML:', res.message);
    } else if (res.code === -2) {
        console.log(res.message);
    } else {
        console.log('Error:', res.message);
    }
});
```

### Response
#### Success Response (code: 1)
- **message** (string) - The rendered HTML of the new comment.
- **is_in_same_container** (integer) - 1 if the comment depth is within the limit, otherwise 0.
- **wc_all_comments_count_new** (integer) - The updated total count of comments.
- **wc_new_comment_id** (integer) - The ID of the newly created comment.

#### Moderation Response (code: -2)
- **message** (string) - A message indicating the comment is awaiting moderation.

#### Error Response (code: -1)
- **message** (string) - An error message detailing the validation failure.
```

--------------------------------

### Live Update (Poll for New Comments)

Source: https://context7.com/wp-plugins/wpdiscuz/llms.txt

Polls for new comments since the last known comment ID. This AJAX handler can either refresh the full comment list or display notification buttons for new comments.

```APIDOC
## AJAX: Live Update (Poll for New Comments)

### Description
Polls for new comments since the last known comment ID. Depending on `wc_comment_list_update_type` (1 = auto-reload full list, 2 = show notification buttons), returns either the refreshed comment HTML or counts of new comments and replies.

### Method
POST

### Endpoint
`wc_ajax_obj.url`

### Parameters
#### Query Parameters
- **action** (string) - Required - `wc_live_update`
- **wc_post_id** (integer) - Required - The ID of the post to check comments for.
- **wc_last_comment_id** (integer) - Required - The highest comment ID seen so far.
- **wc_last_new_comment_id** (integer) - Required - The ID of the last new comment.
- **wc_last_new_reply_id** (integer) - Required - The ID of the last new reply.
- **wc_comments_offset** (integer) - Required - The current page offset.
- **wc_curr_user_comment_count** (integer) - Required - The current user's comment count.
- **wc_author_email** (string) - Optional - For guest users, the author's email.

### Response
#### Success Response (200)
- **code** (integer) - 1 for full list update, 2 for notification buttons.
- **message** (string) - Full rendered comment list HTML if `code` is 1, or button text if `code` is 2.
- **wc_last_comment_id** (integer) - New highest comment ID if `code` is 1.
- **wc_all_comments_count_new** (integer) - Total approved comment count if `code` is 1.
- **wc_new_comment_count** (integer) - Number of new top-level comments if `code` is 2.
- **wc_new_comment_button_text** (string) - Text for the new comment button if `code` is 2.
- **wc_new_reply_count** (integer) - Number of new replies to user's comments if `code` is 2.
- **wc_new_reply_button_text** (string) - Text for the new reply button if `code` is 2.

### Request Example
```javascript
jQuery.post(wc_ajax_obj.url, {
    action:                     'wc_live_update',
    wc_post_id:                 42,
    wc_last_comment_id:         200,
    wc_last_new_comment_id:     200,
    wc_last_new_reply_id:       200,
    wc_comments_offset:         1,
    wc_curr_user_comment_count: 0,
    wc_author_email:            'jane@example.com'
}, function(response) {
    var res = JSON.parse(response);

    if (res.code === 1) {
        jQuery('.wc-thread-wrapper').html(res.message);
    } else if (res.code === 2) {
        jQuery('.wc_new_comment_button_text').text(
            res.wc_new_comment_count + ' ' + res.wc_new_comment_button_text
        );
    }
});
```
```

--------------------------------

### Filter Custom Profile URL

Source: https://context7.com/wp-plugins/wpdiscuz/llms.txt

Use the 'wpdiscuz_profile_url' filter to override the default profile link shown on comment author names. You need to return the modified $data array.

```php
add_filter('wpdiscuz_profile_url', function($data) {
    // $data['user_id']  — WP user ID
    // $data['permalink'] — set this to your custom profile URL
    $data['permalink'] = 'https://example.com/members/' . $data['user_id'] . '/';
    return $data;
});
```
Tokens:
Raw