# Review with reason

**URL:** https://meta.discourse.org/t/review-with-reason/323835
**Category:** Theme component
**Created:** [August 28, 2024, 6:18pm UTC](https://meta.discourse.org/t/review-with-reason/323835 "2024-08-28T18:18:01Z")
**Posts on this page:** 10
**Page:** 1

<div class="post-metadata">

### Author: ![Lhc\_fl](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/lhc_fl/32/268115_2.png) [@Lhc\_fl](https://meta.discourse.org/u/Lhc_fl)
#### Post date: [August 28, 2024, 6:18pm UTC](https://meta.discourse.org/t/review-with-reason/323835/1 "2024-08-28T18:18:01Z")

</div>

| | | |
| --- | --- | --- |
| ℹ | **Summary** | This topic component allows you to require fill in the reason for the action when a moderator review |
| 🛠 | **Repository** | [https://github.com/Lhcfl/review-with-reason](https://github.com/Lhcfl/review-with-reason) |
| ❓ | **Install Guide** | [How to install a theme or theme component](https://meta.discourse.org/t/how-do-i-install-a-theme-or-theme-component/63682) |
| 📖 | **New to Discourse Themes?** | [Beginner’s guide to using Discourse Themes](https://meta.discourse.org/t/beginners-guide-to-using-discourse-themes/91966) |

Install this theme component

This component allows/requires moderators to fill in the reason for the operation when review, and then log it in a topic.

**⚠ Note that the topic must be visible to all people who are eligible to review, otherwise the review will fail! Please check the configuration part before installing.**

## Screenshots

### Reviewing

 ![The image shows a computer screen with a pop-up window displaying a text field for a message with an 'OK' button next to a 'Cancel' button. (Captioned by AI)](https://global.discourse-cdn.com/meta/original/4X/3/f/5/3f5f60553c73b945735540b6fadc58cc94ed48f3.png)

### Logger topic

 ![This is a screenshot of a social media post containing text. (Captioned by AI)](https://global.discourse-cdn.com/meta/original/4X/5/6/7/567555a1dd9d8eff3c1802772b7509b3acedeaa0.png)

> **More examples**
>
> ![This image is a screenshot of a conversation with a user on a social media platform. The conversation is discussing the appropriateness of a post in a specific group. (Captioned by AI)](https://global.discourse-cdn.com/meta/original/4X/0/9/a/09a47dca3083860ef34f47ae23dcc8c031efe12b.png)  
> ![img](https://global.discourse-cdn.com/meta/original/4X/4/6/5/465fcf1e0c203b8188772e92a389acdcd70df7b6.png)

## Configuration

 ![This is a screenshot of a web interface, likely from a content management system, displaying various settings for topic ID overrides for reviewable type. (Captioned by AI)](https://global.discourse-cdn.com/meta/original/4X/f/d/8/fd8b415be655cc575c5326e3e406a3717605161e.png)

⚠ **IMPORTANT** For any settings including “logger\_topic\_id”:

logger\_topic\_id is the topic used to log the reason.

- Required: The topic must have write permissions for the reviewers (moderators and category moderators), otherwise the review will fail.
- Strongly recommended: This topic should not be visible to other people, unless `hide_reviewable_user_email` and `hide_reviewable_details` are set to true, because it will directly record the email address of the user to be approved, and the reporter of flagged posts.

Settings:

- `logger_topic_id`: Global logger\_topic\_id

- `allow_no_reason`: When on, reviewers can skip providing a reason. Otherwise they must enter a reason.

- `max_length_raw`: Maximum length of a quote in the autolog post

- `skip_for_categories`: For these categories, skip the requirement to explain reason

- `logger_topic_id_override_for_catrgories` and `logger_topic_id_override_for_reviewable_type`: For these cases, override logger\_topic\_id. For example, as only moderators can review users, you can set up a dedicated logger\_topic for this type.

- `hide_reviewable_details`: Hide details of reviewable entries in the log, usually are who reported, when, and why.

- `hide_reviewable_user_email`: Hide the email of the reviewable user in the log

- `hide_reviewable_user_fields`: Names of the user fields to hide for reviewable users in the log

---

<div class="post-metadata">

### Author: ![Lilly](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/lilly/32/575047_2.png) [@Lilly](https://meta.discourse.org/u/Lilly)
#### Post date: [August 28, 2024, 8:06pm UTC](https://meta.discourse.org/t/review-with-reason/323835/4 "2024-08-28T20:06:59Z")

</div>

This is an awesome theme component. Nice work @Lhc_fl 😃 👏

---

<div class="post-metadata">

### Author: ![Heliosurge](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/heliosurge/32/571810_2.png) [@Heliosurge](https://meta.discourse.org/u/Heliosurge)
#### Post date: [August 28, 2024, 10:32pm UTC](https://meta.discourse.org/t/review-with-reason/323835/5 "2024-08-28T22:32:53Z")

</div>

> [@Lhc\_fl](#):
>
> Strongly recommended: This topic should not be visible to other people, because it will directly record the email address of the user to be approved.

Very cool TC. Since only full mods & admin can approve new users.

Would it be possible to have Approve new user system flags routed to a seperate topic?

As probably not a good idea to share category topic with non staff.  
At least depending on how a site chooses category mods.

---

<div class="post-metadata">

### Author: ![Lhc\_fl](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/lhc_fl/32/268115_2.png) [@Lhc\_fl](https://meta.discourse.org/u/Lhc_fl)
#### Post date: [August 29, 2024, 1:40am UTC](https://meta.discourse.org/t/review-with-reason/323835/6 "2024-08-29T01:40:02Z")

</div>

Good suggestion! The theme component has been updated and this can now be done with `logger_topic_id_override_for_reviewable_type`: `ReviewableUser=>topic_id`

---

<div class="post-metadata">

### Author: ![NateDhaliwal](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/natedhaliwal/32/313494_2.png) [@NateDhaliwal](https://meta.discourse.org/u/NateDhaliwal)
#### Post date: [August 29, 2024, 2:32am UTC](https://meta.discourse.org/t/review-with-reason/323835/7 "2024-08-29T02:32:01Z")

</div>

Is it possible to allow special groups?

---

<div class="post-metadata">

### Author: ![Lhc\_fl](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/lhc_fl/32/268115_2.png) [@Lhc\_fl](https://meta.discourse.org/u/Lhc_fl)
#### Post date: [August 29, 2024, 4:44pm UTC](https://meta.discourse.org/t/review-with-reason/323835/8 "2024-08-29T16:44:40Z")

</div>

I don’t quite understand this sentence, what does it mean to allow special groups?

---

<div class="post-metadata">

### Author: ![NateDhaliwal](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/natedhaliwal/32/313494_2.png) [@NateDhaliwal](https://meta.discourse.org/u/NateDhaliwal)
#### Post date: [August 30, 2024, 12:57am UTC](https://meta.discourse.org/t/review-with-reason/323835/9 "2024-08-30T00:57:14Z")

</div>

I’m sorry, let me correct myself.  
Is it possible to allow groups or TLs to have access to this as well? For example, trusted users like TL4s.

---

<div class="post-metadata">

### Author: ![Lhc\_fl](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/lhc_fl/32/268115_2.png) [@Lhc\_fl](https://meta.discourse.org/u/Lhc_fl)
#### Post date: [August 30, 2024, 1:02am UTC](https://meta.discourse.org/t/review-with-reason/323835/10 "2024-08-30T01:02:09Z")

</div>

If you mean the logger topic… yes, it only has the requirement that the auditor should have write permission to it. It can be seen by any group you want, the only thing you need to worry about is leaking informations you think shouldn’t be seen

---

<div class="post-metadata">

### Author: ![NateDhaliwal](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/natedhaliwal/32/313494_2.png) [@NateDhaliwal](https://meta.discourse.org/u/NateDhaliwal)
#### Post date: [August 30, 2024, 1:05am UTC](https://meta.discourse.org/t/review-with-reason/323835/11 "2024-08-30T01:05:15Z")

</div>

Additionally, is it possible to allow other users instead of Moderators to add a reason? Category mods could be them.  
(I’m sorry if I just repeated myself)

---

<div class="post-metadata">

### Author: ![Lhc\_fl](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/lhc_fl/32/268115_2.png) [@Lhc\_fl](https://meta.discourse.org/u/Lhc_fl)
#### Post date: [August 30, 2024, 1:18am UTC](https://meta.discourse.org/t/review-with-reason/323835/12 "2024-08-30T01:18:39Z")

</div>

As long as `/review` is accessible to the user, it will allow giving reasons in the review
