zhihe/restricted-posts

Allow post authors to mark their posts as restricted content

v1.0.0 2025-08-12 02:07 UTC

Requires

• php: ^8.1
• flarum/core: ^1.8.0

MIT

• Zhihe Team

• extension
• content
• posts
• flarum
• restricted

README

A Flarum extension that allows post authors to mark their posts as restricted content with visual indicators and integrated access control.

✨ Features

• 🔒 Post Marking: Post authors can mark their own posts as restricted
• 🎯 Visual Indicators: Lock icon badges appear on restricted posts
• ⚙️ Post Controls: Easy mark/unmark via post dropdown menu
• 📝 Composer Integration: Checkbox to mark posts as restricted during creation
• 🌐 Multi-language: English and Chinese (Simplified) support
• 🔗 Extension Integration: Works with money systems and access control

📋 Requirements

• Flarum 1.8.0+
• PHP 8.1+

🚀 Installation

composer require zhihe/restricted-posts
php flarum extension:enable zhihe-restricted-posts
php flarum migrate

Usage

For Post Authors

• Use the "Restricted" checkbox when creating posts
• Mark existing posts via the post dropdown menu (⋮)
• Only post authors can mark/unmark their own posts

Visual Design

• 🔒 Orange lock badge appears on the right side of post headers
• Works alongside zhihe-primary-posts bookmark badges
• Consistent styling with Flarum's design system

🔗 Integration

This extension is designed to work seamlessly with:

• zhihe-money-system: Provides the is_restricted flag for money-based content filtering
• zhihe-primary-posts: Compatible badge positioning
• Access control systems: Integrates with permission-based restrictions

🛠️ Development

Local Development Setup

git clone https://github.com/echolocked/zhihe-restricted-posts.git
cd zhihe-restricted-posts
composer install
cd js && npm install && npm run build

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

MIT License

🆘 Support

• Issues: GitHub Issues
• Community: Flarum Community Forum

Love this extension? Consider starring the repository and sharing it with the Flarum community! ⭐