Skip to content

Rewrite the README and sync the composer description #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bonelifer merged 1 commit into from
Sep 28, 2026
Merged

Rewrite the README and sync the composer description #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 42 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,53 @@
phpbb-3.1-ext-groupswitches
=========================
# Group Switches

phpBB extension to allow the use of group switches in HTML files.
[![Tests](https://github.com/phpbbmodders/phpbb-3.1-ext-groupswitch/actions/workflows/tests.yml/badge.svg)](https://github.com/phpbbmodders/phpbb-3.1-ext-groupswitch/actions/workflows/tests.yml) [![Lint](https://github.com/phpbbmodders/phpbb-3.1-ext-groupswitch/actions/workflows/lint.yml/badge.svg)](https://github.com/phpbbmodders/phpbb-3.1-ext-groupswitch/actions/workflows/lint.yml)

Lets style templates show or hide content based on the viewer's groups.

## Features

- Sets a template switch `S_GROUP_<id>` for every group the current user is in, on every page.
- An ACP page lists your groups with their IDs.

## Requirements

- phpBB 3.3.19 or later
- PHP 7.4 or later

## Installation

### 1. clone
Clone (or download and move) the repository into the folder phpBB3/ext/phpbbmodders/groupswitches:
1. Copy the extension to `/ext/phpbbmodders/groupswitches`
2. In the Administration Control Panel, go to **Customise → Manage extensions**
3. Enable the **Group Switches** extension
4. Find your group IDs under **ACP → Users and Groups → Group Switches**

## Usage

Put the content in a template event file inside the extension, using the group's ID from the ACP page. For example, `styles/all/template/event/overall_header_navbar_before.html`:

```twig
{% if S_GROUP_5 %}
<div class="rules">Only members of group 5 see this (Administrators, on a default install).</div>
{% endif %}
```
cd phpBB3
git clone https://github.com/phpbbmodders/phpbb-3.1-ext-groupswitch.git ext/phpbbmodders/groupswitches
```

### 2. activate
Go to admin panel -> tab customise -> Manage extensions -> enable Group Switches
Use `styles/all/` for every style, or a style's own folder (such as `styles/prosilver/`) for just that style, then purge the board cache. The template events you can use are listed in phpBB's [event documentation](https://area51.phpbb.com/docs/dev/3.3.x/extensions/events_list.html).

## Contributing

Contributions are welcome!

- **Bug reports**: [Open an issue](https://github.com/phpbbmodders/phpbb-3.1-ext-groupswitch/issues).
- **Everything else** (questions, feature requests, ideas, general discussion): [Use Discussions](https://github.com/orgs/phpbbmodders/discussions), or the [community forum](https://www.phpbbmodders.com/community/).
- Pull requests are welcome for bug fixes or discussed features.

## Acknowledgments

### 3. use
To use this extension you should know the template events that are available for you. You can find these template events [here](https://wiki.phpbb.com/Event_List#Template_Events) toward the bottom of the page.
- Original extension by Rich McGirr ([RMcGirr83](https://github.com/rmcgirr83)).
- Code review, bug fixes, and documentation assisted by [Claude](https://www.anthropic.com/claude).

Once you determine the template event you want to use, simply make a new template event html file with the code you want for the group switch to display. An example can be found [here](https://www.phpbb.com/support/docs/en/3.0/kb/article/creating-group-template-switches/) you do not need the edits to the core PHP phpBB files.
## License

Directories have been created but unpopulated in the extensions directory where you can add your html file and it will be automagically included into the forums html files (use the "all" directory if you want it displayed on every template or prosilver or subsilver if you only want it to display on those styles). Simply add your html file into the event directory of whichever style.
This extension is licensed under the **GNU General Public License v2.0**.

To achieve a list of numbers that are associated with your groups visit the user and groups tab and click on the Group Switches link.
See [license.txt](license.txt) for more information.
2 changes: 1 addition & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "phpbbmodders/groupswitches",
"type": "phpbb-extension",
"description": "phpBB 3.1 extension to allow the use of group switches in HTML files",
"description": "Lets style templates show or hide content based on the viewer's groups.",
"homepage": "https://www.phpbbmodders.com/",
"version": "1.0.0",
"time": "2015-01-25",
Expand Down
Loading