Reading Time: 3 minutes

1,599 Views

Understanding and managing application routes is fundamental in web development, allowing developers to define URL endpoints and direct incoming requests to specific controllers and methods.

In this tutorial, we’ll see the process of retrieving all defined application routes in CodeIgniter 4. This functionality enables developers to dynamically inspect and utilize routes for tasks such as generating navigation menus, documentation generation, or route-specific functionality.

Let’s get started.

CodeIgniter 4 Installation

To create a CodeIgniter 4 setup run this given command into your shell or terminal. Please make sure composer should be installed.

composer create-project codeigniter4/appstarter codeigniter-4

Assuming you have successfully installed application into your local system.

Environment (.env) Setup

When we install CodeIgniter 4, we will have env file at root. To use the environment variables means using variables at global scope we need to do env to .env

Either we can do via renaming file as simple as that. Also we can do by terminal command.

Open project in terminal

cp env .env

Above command will create a copy of env file to .env file. Now we are ready to use environment variables.

Enable Development Mode

CodeIgniter starts up in production mode by default. You need to make it in development mode to see any error if you are working with application.

Open .env file from root.

# CI_ENVIRONMENT = production

 // Do it to 
 
CI_ENVIRONMENT = development

Now application is in development mode.

Create Controller

Back to project terminal and run this command to create a controller file.

php spark make:controller Site --suffix

Above command will create a file i.e SiteController.php inside /app/Controllers folder.

Open SiteController.php and write this code into it.

<?php

namespace App\Controllers;

use App\Controllers\BaseController;

class SiteController extends BaseController
{
	// Show all routes
	public function showAllRoutes()
	{
		echo command("routes");
	}
}

Create Route

Open Routes.php file from /app/Config folder. Add this route into it.

//...

$routes->get("my-routes", "SiteController::showAllRoutes");

//...

Application Testing

Open project terminal and start development server via command:

php spark serve

To list all routes

URL: http://localhost:8080/my-routes

Additionally, you can list all application routes via spark command into terminal directly.

php spark routes

Output be,

That’s it.

We hope this article helped you to learn about CodeIgniter 4 Get All Application Routes Example Tutorial in a very detailed way.

If you liked this article, then please subscribe to our YouTube Channel for PHP & it’s framework, WordPress, Node Js video tutorials. You can also find us on Twitter and Facebook.