Documentation :: cBB Reactions


Quick Guide • Requirements

cBB Reactions needs very few requirements to run correctly.

The basic requirements are:
  1. A phpBB forum whose version is equal or greater than 3.2.0.
  2. For the function of filtering by score, phpBB greater than or equal to 3.2.8 is required.
  3. The browser must support Javascript in order to use and manage the extension.

Quick Guide • Install

  1. Unzip the installer file to a local directory (on your computer).
  2. Upload all the files contained in the upload folder of that file (maintaining the directory structure) to the ext directory located in the root directory of your forum.
    The final route for the extension files should be: /ext/canidev/reactions/
  3. Using your web browser, navigate to Admin Panel >> Personalize >> Extensions
  4. Find cBB Reactions and click on the Enable option.

Quick Guide • Uninstall

cBB Reactions can be uninstalled in a few steps:

  1. Using your web browser, navigate to Admin Panel >> Personalize >> Extensions.
  2. Find cBB Reactions and click on the Disable option.
  3. Once disabled, if you want to completely delete it, click on Delete Data and then delete the directory /ext/canidev/reactions from your server.
  4. If you want to remove the files uploaded through the gallery, delete the /files/reactions/ directory.

Configuration • General Options

  1. Allow self reactions.
    Defines whether a user will be able to react to their own messages within the forum.
  2. Allow reaction change.
    Defines if users will be able to modify/remove their reaction to a message once set.
  3. Force reaction to reply.
    Enabling this option will force users to have to react to the first post in a topic in order to post replies within that topic.
  4. Force reaction to view attachments.
    Enabling this option will force users to have to react to a message in order to see the attachments included in it.
  5. List order.
    Defines the order in which users will be displayed within the reactions dialog of a message.
    Available options: Reaction date, username

Configuration • Configure Reactions

Reaction's list

  1. Enable/Disable reaction.
    Disabling a reaction only hides it, it doesn't delete the associated data.
  2. Delete reaction.
    This deletes all associated data and is irreversible.
  3. Set order of appearance.
    By dragging the arrows on the left side, you can set the order in which reactions will appear on the forum.
  4. Edit reaction.
    Clicking on the reaction name takes you to the editing page.

Editing page

  1. Title
    Sets the name associated with this reaction.
  2. Enabled
    Sets whether the reaction will be visible to users.
  3. Score
    Points associated with this reaction. These points are assigned to messages that have this reaction and can be used to filter messages via phpBB's message ordering and filtering tools (>= 3.2.8).
  4. Color
    Color of the text associated with this reaction.
  5. Image
    Image associated with this reaction. You can select from predefined or upload custom images.

Events • Core


reactions.acp_config_before

  • Added in version: 1.0.0
  • Location: controller/admin_config.php
  • Arguments: display_vars, submit, cfg_array, error

reactions.acp_config_after

  • Added in version: 1.0.0
  • Location: controller/admin_config.php
  • Arguments: display_vars, cfg_array

reactions.acp_manage_edit_before

  • Added in version: 1.0.0
  • Location: controller/admin_manage.php
  • Arguments: display_vars, submit, cfg_array, error

reactions.acp_manage_edit_after

  • Added in version: 1.0.0
  • Location: controller/admin_manage.php
  • Arguments: display_vars, cfg_array

reactions.acp_manage_change_status

  • Added in version: 1.0.0
  • Location: controller/admin_manage.php
  • Arguments: reaction_id, status

reactions.acp_manage_delete

  • Added in version: 1.0.0
  • Location: controller/admin_manage.php
  • Arguments: reaction_id

reactions.add_remove_after

  • Added in version: 1.0.0
  • Location: controller/main.php
  • Arguments: mode, post_id, user_id, reaction_id

reactions.main_view_row

  • Added in version: 1.0.0
  • Location: controller/main.php
  • Arguments: ary, row

reactions.get_posts_reactions_after

  • Added in version: 1.0.0
  • Location: libraries/reaction_manager.php
  • Arguments: reaction_ary, post_ary, full_data