README

Favigation turns any navigation data into clean HTML markup — without wrestling with recursion, nested loops, or edge cases.

composer require wwaz/favigation-php

Requirements

• PHP ^8.1
• Composer 2
• Illuminate Support ^10|^11|^12 (works great in Laravel projects, but can also be used standalone)

What it does

You give Favigation a flat list of menu items. It automatically builds a correctly nested <ul> structure — including sorting, active state, and fully customizable HTML output.

Drivers add out-of-the-box support for different data sources (e.g. WordPress) and UI frameworks (e.g. Bootstrap).

Examples

1. Render a WordPress menu in 3 lines

Got raw WordPress menu data? Just pass it in:

$menudata = [
    ['ID' => 1, 'menu_item_parent' => 0, 'menu_order' => 2, 'url' => '/about', 'title' => 'About us'],
    ['ID' => 2, 'menu_item_parent' => 1, 'menu_order' => 3, 'url' => '/team',  'title' => 'Team'],
    ['ID' => 3, 'menu_item_parent' => 0, 'menu_order' => 1, 'url' => '/',      'title' => 'Home'],
];

$favigation = new wwaz\Favigation\Driver\Wordpress\Builder(
    $menudata,
    wwaz\Favigation\Driver\BasicMenuRenderer::class
);
echo $favigation->toHtml();

Output:

<ul>
    <li><a href="/">Home</a></li>
    <li><a href="/about">About us</a>
        <ul>
            <li><a href="/team">Team</a></li>
        </ul>
    </li>
</ul>

Sorting by menu_order, nesting via menu_item_parent — all handled automatically.

2. Bootstrap navigation with active state

Want Bootstrap-compatible markup with the current page highlighted?

$favigation = (new wwaz\Favigation\Builder(
    new wwaz\Favigation\Collection($data),
    wwaz\Favigation\Driver\Bootstrap\BootstrapMenuRenderer::class
))
    ->tag('ul')
    ->id('main-nav')
    ->selected('getId', 3)  // Marks the item with ID 3 as active
    ->getBuild()
    ->toHtml();

The builder handles setting active classes — no need to traverse the tree yourself.

3. Fully custom HTML — icons, attributes, your own logic

Need total control over the markup?

$favigation
    ->setContent(function($item) {
        $icon = $item->getIcon()
            ? '<img class="icon" src="' . $item->getIcon() . '">'
            : '';

        return $item->getUrl()
            ? $icon . '<a href="' . $item->getUrl() . '">' . $item->getTitle() . '</a>'
            : $icon . '<span>' . $item->getTitle() . '</span>';
    })
    ->setLiAttribute('data-id', function($item) {
        return $item->getId();
    })
    ->toHtml();

Output:

<ul>
    <li data-id="3"><a href="/">Home</a></li>
    <li data-id="1">
        <img class="icon" src="about.svg"><a href="/about">About us</a>
        <ul>
            <li data-id="2"><a href="/team">Team</a></li>
        </ul>
    </li>
</ul>

Every element, every attribute — fully under your control, without managing the tree yourself.

Why Favigation?

Custom Drivers

Favigation is extensible — write your own driver to support any data structure. Documentation available in the repository.

Developer Experience

Useful local commands:

composer test
composer analyse
composer validate

Driver\Wordpress\Builder is provided as a backward-compatible alias and internally reuses WordpressBuilder.

License

MIT License — see LICENSE for details.