Comments

Package docs status

This page is generated from package source documentation in the Capell packages repository and the checked-in manifest. Source documentation is not distribution status. Before running a Composer command, verify that the exact package and compatible 1.x release are available through public Packagist or the authenticated marketplace account.

Field	Value
Composer package	capell-app/comments
Package slug	comments
Product group	Capell Engagement & CRM
Tier	premium
Bundle	engagement-crm
Runtime contexts	admin, frontend
Capell version	^1.0
Catalogue role	extension
Release channel	Beta
Source repository	capell-app/packages
Source path	packages/comments
Docs source	packages/comments/docs
Manifest	capell.json

What This Plugin Adds

Comments is an Available, Schema-owning Capell package in the Capell Engagement & CRM product group. It ships as capell-app/comments and extends these surfaces: admin, frontend.

Comments adds threaded public discussions with author verification, moderation, reactions, reply notifications, and privacy retention controls.

Visitors read and reply to approved threads, while editors review comments, authors, spam, and moderation history in the admin.

Status details:

• Status: Available
• Tier: premium
• Bundle: engagement-crm
• Composer package: capell-app/comments
• Namespace: Capell\Comments
• Theme key: not applicable

Why It Matters

For developers: A commentable registry and focused Actions provide extension points for new content types while keeping public thread building and moderation rules testable.

For teams: Editors can control what becomes public and retain a record of moderation decisions, while retention tools support privacy operations.

Screens And Workflow

Screenshot contract: docs/screenshots.json.

• Comment moderation inbox (frontend, required evidence).
• Comments admin resource (admin, required evidence).
• Comment authors admin resource (admin, required evidence).
• Public comment thread (frontend, required evidence).
• Public comment thread closed state (frontend, supplementary evidence).
• Comment stats dashboard widget (admin, supplementary evidence).
• Comment reply notification email preview (email, supplementary evidence).
• Comments admin resource with admin sidebar menu open (admin, supplementary evidence).

Technical Shape

Service providers

• Capell\Comments\Providers\CommentsServiceProvider
• Capell\Comments\Providers\AdminServiceProvider
• Capell\Comments\Providers\FrontendServiceProvider

Config files

• packages/comments/config/capell-comments.php

Migrations

• packages/comments/database/migrations/2026_05_24_000001_create_comment_authors_table.php
• packages/comments/database/migrations/2026_05_24_000002_create_comments_table.php
• packages/comments/database/migrations/2026_05_24_000003_create_comment_tokens_table.php
• packages/comments/database/migrations/2026_05_24_000004_create_comment_moderation_events_table.php
• packages/comments/database/migrations/2026_05_24_000006_add_reply_notification_opt_out_to_comment_authors_table.php
• packages/comments/database/migrations/2026_05_24_000007_create_comment_reactions_table.php
• packages/comments/database/migrations/2026_09_29_120000_remove_implicit_timestamp_updates_from_comments.php

Settings migrations

• packages/comments/database/settings/2026_05_24_000005_create_comments_settings.php

Settings classes

• CommentSettings

Models

• Comment
• CommentAuthor
• CommentModerationEvent
• CommentReaction
• CommentToken

Filament classes

• CommentModerationInbox
• CommentAuthorResource
• ListCommentAuthors
• CommentResource
• ListComments
• CommentsTable
• CommentSettingsSchema
• CommentsDashboardSettingsContributor
• CommentStatsFilamentWidget
• LatestCommentsFilamentWidget

Livewire components

• CommentThreadComponent

Route files

• packages/comments/routes/web.php

Policies

• CommentAuthorPolicy
• CommentPolicy

Extension contracts

• CommentSpamProvider

Events

• CommentCreated

Listeners

• NotifyModeratorsOfNewComment

Actions

• ApplyCommentPrivacyRetentionAction
• BuildCommentPrivacyExportAction
• BuildPublicThreadAction
• CommentModerationEventAction
• CreateCommentAction
• DisableCommentAuthorReplyNotificationsAction
• EraseCommentPrivacyDataAction
• InstallCommentsPackageAction
• InvalidateCommentableCacheAction
• ListCommentableTypeOptionsAction
• RegisterCommentEmailTemplatesAction
• RegisterDefaultCommentablesAction
• RequestCommentEmailVerificationAction
• RequestCommentReplyNotificationAction
• ResolveCommentPrivacyRecordIdsAction
• ResolveCommentableFromPayloadAction
• ResolvePublicCommentableThreadAction
• ScoreCommentSpamAction
• ToggleCommentReactionAction
• TransitionCommentStatusAction
• UpdateCommentAuthorModerationAction
• VerifyCommentAuthorEmailAction

Data objects

• CommentEmailTemplateData
• CommentPrivacyRecordIdsData
• CommentPrivacyRetentionResultData
• CommentReactionResultData
• CommentSpamCheckData
• CommentSpamReasonData
• CommentSpamScoreData
• CommentableTypeData
• CreateCommentData
• PublicCommentData
• PublicCommentableThreadData

Command signatures

• capell-comments:install
• capell-comments:privacy-retention

Manifest action API

• applyPrivacyRetention: Capell\Comments\Actions\ApplyCommentPrivacyRetentionAction
• disableReplyNotifications: Capell\Comments\Actions\DisableCommentAuthorReplyNotificationsAction
• install: Capell\Comments\Actions\InstallCommentsPackageAction
• requestReplyNotification: Capell\Comments\Actions\RequestCommentReplyNotificationAction
• scoreSpam: Capell\Comments\Actions\ScoreCommentSpamAction
• toggleReaction: Capell\Comments\Actions\ToggleCommentReactionAction

Console command classes

• InstallCommentsCommand
• PruneCommentPrivacyDataCommand

Manifest contributions

• admin-resource: Capell\Comments\Manifest\CommentAdminResourcesContribution
• dashboard-widget: Capell\Comments\Manifest\CommentDashboardFilamentWidgetsContribution
• frontend-component: Capell\Comments\Manifest\CommentFrontendComponentsContribution
• migration: Capell\Comments\Manifest\CommentsMigrationsContribution
• model: Capell\Comments\Manifest\CommentModelsContribution
• route: Capell\Comments\Manifest\CommentRoutesContribution
• setting: Capell\Comments\Manifest\CommentSettingsContribution

Health checks

• Capell\Comments\Health\CommentsHealthCheck

Blade views

• packages/comments/resources/views/emails/approved.blade.php
• packages/comments/resources/views/emails/pending-moderation.blade.php
• packages/comments/resources/views/emails/rejected.blade.php
• packages/comments/resources/views/emails/reply-notification.blade.php
• packages/comments/resources/views/emails/verify-email.blade.php
• packages/comments/resources/views/filament/comment-context.blade.php
• packages/comments/resources/views/filament/moderation-inbox.blade.php
• packages/comments/resources/views/livewire/partials/comment-list.blade.php
• packages/comments/resources/views/livewire/thread-livewire.blade.php
• packages/comments/resources/views/livewire/thread-shell.blade.php
• packages/comments/resources/views/livewire/thread.blade.php
• packages/comments/resources/views/reply-notifications-disabled.blade.php
• packages/comments/resources/views/verify-email.blade.php

Cache tags

• comments

Data Model

• Required tables: comment_authors, comments, comment_tokens, comment_moderation_events, comment_reactions.
• Models: Comment, CommentAuthor, CommentModerationEvent, CommentReaction, CommentToken.
• Core record references in migrations: sites via site_id, languages via language_id, users via user_id.
• Migration files: 2026_05_24_000001_create_comment_authors_table.php, 2026_05_24_000002_create_comments_table.php, 2026_05_24_000003_create_comment_tokens_table.php, 2026_05_24_000004_create_comment_moderation_events_table.php, 2026_05_24_000006_add_reply_notification_opt_out_to_comment_authors_table.php, 2026_05_24_000007_create_comment_reactions_table.php, 2026_09_29_120000_remove_implicit_timestamp_updates_from_comments.php.
• Migration impact: run host migrations through the package install flow before opening package surfaces.
• Deletion/retention behaviour: migrations declare cascade-on-delete relationships and null-on-delete relationships; no timed pruning or retention schedule is declared in capell.json.

Install Impact

• Required packages: capell-app/admin, capell-app/core, capell-app/frontend.
• Admin navigation: declares admin-resource: CommentAdminResourcesContribution; each Filament page or resource controls its own navigation visibility.
• Admin/editor extensions: dashboard-widget: CommentDashboardFilamentWidgetsContribution.
• Permissions: ViewAny:Comment, View:Comment, Update:Comment, Approve:Comment, Delete:Comment, ViewAny:CommentAuthor, View:CommentAuthor, Update:CommentAuthor; access also governed by package policies: CommentAuthorPolicy, CommentPolicy.
• Public routes: loads routes/web.php; registers CommentRoutesContribution.
• Database changes: package migrations are declared.
• Config: config/capell-comments.php.
• Settings: Capell\Comments\Settings\CommentSettings.
• Queues or schedules: none declared.
• Cache tags: comments.
• Commands: capell-comments:install, capell-comments:privacy-retention.

Common Pitfalls

• Keep required Capell packages on compatible v4 releases: capell-app/admin, capell-app/core, capell-app/frontend.
• Run migrations before opening package resources or public routes.
• Review package configuration before production-like verification: config/capell-comments.php, Capell\Comments\Settings\CommentSettings.
• Review middleware, throttling, signatures, and public-output safety in routes/web.php before exposing routes.
• Keep public Blade and cached HTML free of authoring markers, model IDs, permissions, signed editor URLs, and lazy database queries.
• Custom write integrations must preserve invalidation for comments cache tags.

Troubleshooting

Symptom	Likely cause	Check	Fix
Package surface is missing after install	Provider or manifest is not loaded	Confirm capell.json, package composer.json, and provider registration	Reinstall the package, refresh Composer autoload, and clear host caches
Admin screen or command fails on missing table	Package migrations have not run	Check the tables listed in Data Model	Run host migrations and rerun the focused package test
Route returns unexpected output	Route cache, middleware, or signed URL setup does not match the package route file	Check the route files listed in Technical Shape	Clear route cache and verify middleware before exposing public routes
Public output leaks unexpected state	Render data, cache variation, or authoring boundary has regressed	Check public Blade, cache tags, and public-output safety tests	Move data loading out of Blade and rerun the package public-output tests

Quick Start

1. Install the package: composer require capell-app/comments.
2. Run the package setup: php artisan capell-comments:install.
3. Open the package admin surface at /admin/comments and confirm Comments is available.

Next Steps

• Package docs
• Overview
• Worked extension examples
• Admin guide
• Configuration files: config/capell-comments.php.
• Troubleshooting
• Screenshot contract
• Marketplace assets
• Capell content language plan
• Capell documentation design system
• Capell and package ERD notes
• Related packages: Blog, Email Studio, Html Cache.