Strapi Comments Plugin

To install the plugin in your Strapi project, use yarn (recommended). After installation, you must rebuild your Strapi instance to make the plugin appear in the sidebar.

1. Install the package:

   yarn add strapi-plugin-comments@latest

2. Rebuild and restart your instance:

   yarn build
   yarn develop

Once running, the Comments plugin will be visible in the Plugins section of the Strapi sidebar.

The strapi-plugin-comments plugin exposes two distinct sets of routes categorized by their access type:

1. content-api: These routes are intended for client-side consumption (e.g., your frontend application) to interact with comments. They are defined under the clientRoutes module.
2. admin: These routes are intended for the Strapi Admin panel to manage comments. They are defined under the adminRoutes module.

When integrating or extending the plugin, ensure you are targeting the correct route type based on whether the request originates from a user-facing frontend or the Strapi administrative interface.

To use GraphQL with the Comments plugin, you must have @strapi/plugin-graphql installed and enabled.

Important: When using config/plugins.{js|ts}, place the comments property before the graphql property. This ensures that dynamic types added during the bootstrap stage are correctly added to the GraphQL Schema.

Inside the gql configuration object, you can set:

• auth: Determines if GraphQL queries require authentication. Default: false.

If auth is set to true, you must provide an Authorization header (e.g., Bearer <token>) with your requests.

{
  "comments": {
    "config": {
      "gql": {
        "auth": true
      }
    }
  },
  "graphql": {
    // ...
  }
}

You can configure the plugin using the dedicated Settings page in the Strapi admin panel (recommended for validation) or by modifying your config/plugins.{js|ts} file.

If you use the file-based configuration, ensure you use the comments key within the exported object. If the file does not exist, create it manually.

module.exports = ({ env }) => ({
  //...
  comments: {
    enabled: true,
    config: {
      badWords: false,
      moderatorRoles: ["Authenticated"],
      approvalFlow: ["api::page.page"],
      entryLabel: {
        "*": ["Title", "title", "Name", "name", "Subject", "subject"],
        "api::page.page": ["MyField"],
      },
      blockedAuthorProps: ["name", "email"],
      reportReasons: {
        MY_CUSTOM_REASON: "MY_CUSTOM_REASON",
      },
      gql: {
        // ...
      },
    },
  },
  //...
});

The admin/src/index.ts file serves as the entrypoint for the Strapi admin panel integration. It defines how the plugin registers itself within the Strapi admin UI, including adding menu links, creating settings sections, and handling internationalization (translations).

Key lifecycle methods exported by the default object:

• register(app): Used to inject the plugin into the Strapi admin application. It adds a menu link to the sidebar and creates a settings section for plugin configuration.
• registerTrads({ locales }): An asynchronous function used to load and prefix plugin translations for the specified locales.

If you are using GraphQL and encounter 403/500 errors or missing types, it is likely because strapi-plugin-graphql is initializing before the comments plugin, preventing types from being injected correctly.

To fix this, ensure the comments plugin is initialized before the graphql plugin in your config/plugins.{js|ts} file.

module.exports = {
  comments: { enabled: true },
  graphql: { enabled: true },
};

The plugin provides several mutations to handle abuse reports:

• resolveAbuseReport: Resolves a single specific report by reportId.
• resolveCommentMultipleAbuseReports: Resolves a list of reportIds for a specific comment.
• resolveAllAbuseReportsForComment: Resolves all reports associated with a single comment.
• resolveAllAbuseReportsForThread: Resolves all reports for a comment and its entire thread.
• resolveMultipleAbuseReports: Resolves multiple reports by their IDs across the system (requires relation and reportIds).

# Example: Resolve a single report
mutation resolveAbuseReport {
  resolveAbuseReport(
    input: {
      id: "2"
      relation: "api::page.page:njx99iv4p4txuqp307ye8625"
      reportId: 15
    }
  ) {
    id
    content
    updatedAt
  }
}

Use the findAllInHierarchy GraphQL query to fetch comments and their nested children for a specific content relation. This is useful for rendering threaded comment sections.

Note on Authorship: If you are using Strapi's authentication/authorization (auth/authz), the user context provided by the request takes priority over the author property passed in the payload.

query {
  findAllInHierarchy(relation: "api::page.page:njx99iv4p4txuqp307ye8625") {
    id
    content
    blocked
    children {
      id
      content
    }
    threadOf {
      id
    }
    author {
      id
      name
    }
  }
}

Use blockComment or unblockComment mutations to moderate individual comments. Both require the comment id and the relation string.

# Block a comment
mutation blockComment {
  blockComment(input: {
    id: "2"
    relation: "api::page.page:njx99iv4p4txuqp307ye8625"
  }) {
    id
    blocked
    content
  }
}

# Unblock a comment
mutation unblockComment {
  unblockComment(input: {
    id: "2"
    relation: "api::page.page:njx99iv4p4txuqp307ye8625"
  }) {
    id
    blocked
  }
}