Skip to content
Get started with PHP and Laravel faster than ever using Laravel Herd.
Join us in Dallas, TX! Tickets are now available for Laracon US.
Let's go to India! Tickets are now available for Laracon IN.
Let's go to Europe! Tickets are now available for Laracon EU.
Let's go down under! Tickets are now available for Laracon AU.
Servers with PHP 8.3 are now available for provisioning via Laravel Forge.
Deploy Laravel with the infinite scale of serverless using Laravel Vapor.
How's your health? Check your application's vital signs using Laravel Pulse.
Incoming transmission received. Laravel Reverb is now available!
Take your administration backend to another dimension with Laravel Nova.
Laravel is hiring! Help us build the future of Laravel.
Preface
●
Introduction
●
Quickstart
●
Release Notes
●
Upgrade Guide
●
Contribution Guide
Getting Started
●
Installation
●
Configuration
●
Homestead
●
Request Lifecycle
●
Routing
●
Requests & Input
●
Views & Responses
●
Controllers
●
Errors & Logging
Learning More
●
Authentication
●
Billing
●
Cache
●
Core Extension
●
Events
●
Facades
●
Forms & HTML
●
Helpers
●
IoC Container
●
Localization
●
Mail
●
Package Development
●
Pagination
●
Queues
●
Security
●
Session
●
SSH
●
Templates
●
Unit Testing
●
Validation
Database
●
Basic Usage
●
Query Builder
●
Eloquent ORM
●
Schema Builder
●
Migrations & Seeding
●
Redis
Artisan CLI
●
Overview
●
Development
Laravel Forge: create and manage PHP 8 servers. Deploy your Laravel applications in seconds. Sign up now!.
Laravel Vapor: experience extreme scale on a dedicated serverless platform for Laravel. Sign up now!.
Laravel Nova: The next generation of Nova is now available.
Laravel Pulse: How's your health? Check your application's vital signs using Laravel Pulse.
Laravel Reverb: You can easily build dynamic, real-time Laravel applications using WebSockets. Laravel Reverb is now available!
Preface
●
Introduction
●
Quickstart
●
Release Notes
●
Upgrade Guide
●
Contribution Guide
Getting Started
●
Installation
●
Configuration
●
Homestead
●
Request Lifecycle
●
Routing
●
Requests & Input
●
Views & Responses
●
Controllers
●
Errors & Logging
Learning More
●
Authentication
●
Billing
●
Cache
●
Core Extension
●
Events
●
Facades
●
Forms & HTML
●
Helpers
●
IoC Container
●
Localization
●
Mail
●
Package Development
●
Pagination
●
Queues
●
Security
●
Session
●
SSH
●
Templates
●
Unit Testing
●
Validation
Database
●
Basic Usage
●
Query Builder
●
Eloquent ORM
●
Schema Builder
●
Migrations & Seeding
●
Redis
Artisan CLI
●
Overview
●
Development
WARNING You're browsing the documentation for an old version of Laravel.
Consider upgrading your project to Laravel 11.x.
Artisan Development
●
Introduction
●
Building A Command
●
Registering Commands
●
Calling Other Commands
Introduction
In addition to the commands provided with Artisan, you may also build your own custom commands for working with your application. You may store your custom commands in the app/commands
directory; however, you are free to choose your own storage location as long as your commands can be autoloaded based on your composer.j
son
settings.
Building A Command
Generating The Class
To create a new command, you may use the command:make
Artisan command, which will generate a command stub to help you get started:
Generate A New Command Class
php artisan command:make FooCommand
By default, generated commands will be stored in the app/command
s
directory; however, you may specify custom path or namespace:
php artisan command:make FooCommand --path=app/classes --namespace=Classes
When creating the command, the -
-command
option may be used to assign the terminal command name:
php artisan command:make AssignUsers --command=users:assign
Writing The Command
Once your command is generated, you should fill out the name
and description
properties of the class, which will be used when displaying your command on the lis
t
screen.
The fire
method will be called when your command is executed. You may place any command logic in this method.
Arguments & Options
The getArguments
and getOptions
methods are where you may define any arguments or options your command receives. Both of these methods return an array of commands, which are described by a list of array options.
When defining arguments
, the array definition values represent the following:
array($name, $mode, $description, $defaultValue)
The argument mode
may be any of the following: InputArgument::RE
QUIRED
orInputArgument::OPTIONAL
.
When defining options
, the array definition values represent the following:
array($name, $shortcut, $mode, $description, $defaultValue)
For options, the argument mode
may be: InputOption::VALUE_REQUIR
ED
, InputOption::VALUE_OPTIONAL
, InputOption::VALUE_IS_ARRAY
, In
putOption::VALUE_NONE
.
The VALUE_IS_ARRAY
mode indicates that the switch may be used multiple times when calling the command:
php artisan foo --option=bar --option=baz
The VALUE_NONE
option indicates that the option is simply used as a "switch":
php artisan foo --option
Retrieving Input
While your command is executing, you will obviously need to access the values for the arguments and options accepted by your application. To do so, you may use the argument
and option
methods:
Retrieving The Value Of A Command Argument
$value = $this->argument('name');
Retrieving All Arguments
$arguments = $this->argument();
Retrieving The Value Of A Command Option
$value = $this->option('name');
Retrieving All Options
$options = $this->option();
Writing Output
To send output to the console, you may use the info
, comment
, qu
estion
and error
methods. Each of these methods will use the appropriate ANSI colors for their purpose.
Sending Information To The Console
$this->info('Display this on the screen');
Sending An Error Message To The Console
$this->error('Something went wrong!');
Asking Questions
You may also use the ask
and con
firm
methods to prompt the user for input:
Asking The User For Input
$name = $this->ask('What is your name?');
Asking The User For Secret Input
$password = $this->secret('What is the password?');
Asking The User For Confirmation
if ($this->confirm('Do you wish to continue? [yes|no]'))
{
//
}
You may also specify a default value to the confirm
method, which should be true
orfalse
:
$this->confirm($question, true);
Registering Commands
Registering An Artisan Command
Once your command is finished, you need to register it with Artisan so it will be available for use. This is typically done in the app/start/artisan.php
file. Within this file, you may use the Artisan::add
method to register the command:
Artisan::add(new CustomCommand);
Registering A Command That Is In The IoC Container
If your command is registered in the application IoC container, you may use the Artisan::resolve
method to make it available to Artisan:
Artisan::resolve('binding.name');
Registering Commands In A Service Provider
If you need to register commands from within a service provider, you should call the commands
method from the provider's boot
method, passing the IoC container binding for the command:
public function boot()
{
$this->commands('command.binding');
}
Calling Other Commands
Sometimes you may wish to call other commands from your command. You may do so using the call
method:
$this->call('command:name', array('argument' => 'foo', '--option' => 'bar'));
Laravel is a web application framework with expressive, elegant syntax. We believe development must
be an enjoyable and creative experience to be truly fulfilling. Laravel attempts to take the pain
out of development by easing common tasks used in most web projects.
Highlights
●
Release Notes
●
Getting Started
●
Routing
●
Blade Templates
●
Authentication
●
Authorization
●
Artisan Console
●
Database
●
Eloquent ORM
●
Testing
Resources
●
Laravel Bootcamp
●
Laracasts
●
Laravel News
●
Laracon
●
Laracon AU
●
Laracon EU
●
Laracon India
●
Larabelles
●
Careers
●
Jobs
●
Forums
●
Trademark
Partners
●
Vehikl
●
WebReinvent
●
Tighten
●
Bacancy
●
64 Robots
●
Active Logic
●
Black Airplane
●
Byte 5
●
Curotec
●
Cyber-Duck
●
DevSquad
●
Jump24
●
Kirschbaum
Ecosystem
●
Breeze
●
Cashier
●
Dusk
●
Echo
●
Envoyer
●
Forge
●
Herd
●
Horizon
●
Inertia
●
Jetstream
●
Livewire
●
Nova
●
Octane
●
Pennant
●
Pint
●
Prompts
●
Pulse
●
Reverb
●
Sail
●
Sanctum
●
Scout
●
Socialite
●
Spark
●
Telescope
●
Vapor
Laravel is a Trademark of Laravel Holdings Inc.
Copyright © 2011-2024 Laravel Holdings Inc.
Code highlighting provided by Torchlight