Quick start

Xcomm3x1 min readPage 2 of 11

Install the package via the Package Manager. Then put two snippets on the page: XcommThread outputs the comments, Xcomm3x — the form. Both are called uncached.

[[!XcommThread?
  &resource=`[[*id]]`
  &block_key=`main`
  &limit=`10`
]]

[[!Xcomm3x?
  &resource=`[[*id]]`
  &block_key=`main`
]]

block_key — up to 100 characters: letters, digits, space and _ . : -. It must be unique on the page; with other characters a comment will not be sent. Several blocks on one page — different block_key values:

[[!XcommThread? &resource=`[[*id]]` &block_key=`news` &limit=`5`]]
[[!Xcomm3x?    &resource=`[[*id]]` &block_key=`news`]]

[[!XcommThread? &resource=`[[*id]]` &block_key=`reviews` &limit=`5`]]
[[!Xcomm3x?    &resource=`[[*id]]` &block_key=`reviews`]]

What to configure first

  • Pre-moderation is on by default (xcomm3x.moderation) — new comments wait for approval on the “Moderation queue” tab.
  • For emails to be sent, set xcomm3x.notify_manager_email and configure cron — see Notifications and cron.
  • Bootstrap 5 or UIkit 3 markup — see Themes.

Requirements: MODX 3, PHP 8.2+, MySQL 5.7+ / MariaDB 10.3+, the GD extension (CAPTCHA).