How To Create Custom Helper Functions In Laravel?

Step 1: Create a helpers.php File

To use custom helper functions in Laravel, create a new file called helpers.php. Place this file in the app directory of your Laravel project. This file will store all your custom helper functions in one place, making them easy to manage.

Step 2: Add Helper Functions

After creating the helpers.php file, you can add your custom helper functions. Here's an example of a simple helper function:

if (!function_exists('format_text')) {
    function format_text($text) {
        return ucfirst(strtolower($text));
    }
}

This function takes a string input, changes it to lowercase, and capitalizes the first letter.

When naming your helper functions, follow these practices:

1. Use clear names that explain what the function does.
2. Use lowercase letters and underscores for function names (snake_case).
3. Avoid names that might clash with existing PHP or Laravel functions.
4. Group related functions together in the file for better organization.

By following these steps and practices, you can create a helper file with custom functions that improve your Laravel application's code structure and readability.

"files": [
    "app/helpers.php"
]

Method 1: Using composer.json

To register your helper functions using the composer.json file:

1. Open your project's composer.json file.
2. Find the "autoload" section.
3. Add a "files" array if it's not there.
4. Add the path to your helpers.php file:

"autoload": {
    "psr-4": {
        "App\\": "app/"
    },
    "files": [
        "app/helpers.php"
    ]
}

After editing the composer.json file, run this command in your terminal:

composer dump-autoload

This command updates the Composer autoloader, making your helper functions available in your Laravel application.

"autoload": {
    "files": [
        "app/helpers/string_helpers.php",
        "app/helpers/array_helpers.php",
        "app/helpers/date_helpers.php"
    ]
}

Method 2: Using Service Provider

You can also register helper functions using a service provider:

1. Create a new service provider:

php artisan make:provider HelperServiceProvider

2. Open the new provider file in app/Providers/HelperServiceProvider.php.

3. Add this code to the register method:

public function register()
{
    require_once app_path('helpers.php');
}

4. Register the new service provider in config/app.php:

'providers' => [
    // Other service providers...
    App\Providers\HelperServiceProvider::class,
],

This method loads your helper functions when the application starts, making them available in your Laravel application.

Using Helper Functions in Views

After you create and register your helper functions, you can use them in your Blade templates. Here's how to use a custom helper function in a view:

<p>{{ format_text($user->name) }}</p>

This example uses the format_text helper function to format the user's name. The function runs when the view renders, applying the formatting to the user's name.

You can use helper functions anywhere in your Blade templates, including in control structures:

@if(is_admin(Auth::user()))
    <p>Welcome, Admin!</p>
@endif

This example uses a custom is_admin helper function that checks if a user is an admin.

{{ format_currency(calculate_total($order->items)) }}

Using Helper Functions in Controllers

Helper functions are also available in your controllers. You can use them like any other PHP function. Here's an example in a controller method:

public function show($id)
{
    $user = User::findOrFail($id);
    $formattedName = format_text($user->name);

    return view('user.profile', [
        'user' => $user,
        'formattedName' => $formattedName
    ]);
}

This example uses the format_text helper function to format the user's name before passing it to the view. This keeps your controller code clean and reusable.

You can also use helper functions within other methods in your controller:

public function index()
{
    $users = User::all();
    $adminUsers = $users->filter(function($user) {
        return is_admin($user);
    });

    return view('users.index', compact('users', 'adminUsers'));
}

This example uses a custom is_admin helper function to filter a collection of users.

By using helper functions in views and controllers, you can keep consistent logic across your application, reduce code duplication, and improve code readability.