Skip to content
YajraBox

Laravel DataTables
Icon

WARNING You're browsing the documentation for an upcoming version of Laravel DataTables. The documentation and features of this release are subject to change.

Order Columns

In some cases, you may want to use a custom order SQL for a set of columns. To achieve this, use the orderColumns API.

Special Variables and Placeholders

Variable Description
$1 Replaced with the order direction of the column
:column Replaced with the column name set in the first parameter

Basic Usage

In this example, we will order the column name with nulls as last result:

use Yajra\DataTables\Facades\DataTables;
use App\Models\User;
 
Route::get('user-data', function() {
    $model = User::query();
 
    return DataTables::eloquent($model)
        ->orderColumns(['name', 'email'], '-:column $1')
        ->toJson();
});

Common Patterns

Multiple Columns with Nulls Last

return DataTables::eloquent($model)
    ->orderColumns(['name', 'email', 'created_at'], ':column $1 NULLS LAST')
    ->toJson();

Custom Format

return DataTables::eloquent($model)
    ->orderColumns(['name', 'status'], 'COALESCE(:column, 999) $1')
    ->toJson();

See Also

Edit this page on GitHub