Make your own Filament 3 Plugin!

Introduction

In this tutorial, you will learn how to create your own custom Filament 3 plugin in Laravel. This guide is particularly useful for developers looking to enhance their web applications by adding specific functionalities like user role assignment during registration. We will walk through the process of building a plugin that allows assigning roles to users when they register for a panel.

Step 1: Set Up Your Laravel Environment

Before starting the plugin development, ensure you have the following prerequisites:

• A Laravel application set up (preferably using Laravel 8 or higher).
• FilamentPHP installed in your Laravel project.

Practical Tips

• Use Composer to manage your dependencies.
• Make sure your environment is configured correctly to avoid issues later.

Step 2: Create the Plugin Structure

To initiate the plugin, you need to create the necessary directory structure.

1. Navigate to your Laravel project's packages directory.
2. Create a new directory for your plugin:

   mkdir -p packages/YourNamespace/PanelRoles
   

3. Inside PanelRoles, create a src directory for your plugin's source code:

   mkdir src
   

Step 3: Set Up the Service Provider

Next, you will need to set up a service provider for your plugin.

1. Create a new file in the src directory named PanelRolesServiceProvider.php.
2. Add the following code to the provider:

   namespace YourNamespace\PanelRoles;
   
   use Illuminate\Support\ServiceProvider;
   
   class PanelRolesServiceProvider extends ServiceProvider
   {
       public function boot()
       {
           // Bootstrapping code here
       }
   
       public function register()
       {
           // Registering services here
       }
   }
   

Common Pitfalls

• Ensure the namespace matches your directory structure.
• Don’t forget to register your service provider in the main config/app.php file under providers.

Step 4: Create Middleware for Role Assignment

To ensure that only users with specific roles can access certain functionalities, you will need to create middleware.

1. Create a new middleware in your src directory:

   php artisan make:middleware CheckUserRole
   

2. Add the logic for checking user roles in the created middleware file:

   namespace YourNamespace\PanelRoles\Http\Middleware;
   
   use Closure;
   use Illuminate\Http\Request;
   use Illuminate\Support\Facades\Auth;
   
   class CheckUserRole
   {
       public function handle(Request $request, Closure $next, $role)
       {
           if (!Auth::user() || !Auth::user()->hasRole($role)) {
               return redirect('/'); // Redirect to home if unauthorized
           }
           return $next($request);
       }
   }
   

Practical Advice

• Remember to register your middleware in the app/Http/Kernel.php file.

Step 5: Implement Role Assignment Logic

Now, you will implement the logic to assign roles to users upon registration.

1. Modify the user registration controller to include role assignment:

   use YourNamespace\PanelRoles\Models\Role;
   
   public function register(Request $request)
   {
       $user = User::create($request->all());
       $role = Role::where('name', 'user_role')->first();
       $user->roles()->attach($role);
   }
   

Important Notes

• Ensure that your User model has a relationship defined for roles.
• Test the registration process to confirm that roles are being assigned correctly.

Conclusion

You have successfully created a custom Filament 3 plugin that allows for user role assignment during registration. This plugin enhances your Laravel application by ensuring that users have the appropriate access rights based on their roles.

Next Steps

• Explore additional features you can implement in your plugin.
• Consider looking into the Laravel documentation for more advanced plugin development techniques.
• Check out the live plugin on GitHub for more inspiration and code examples.