README

SEO as a section of the WebX UI admin panel, and the <head> the public side prints from it.

What it owns is everything a page can say about itself: the rules written for addresses, the fields of one entity (HasSeo and seo_meta), what the site says when nothing more specific does, and the addresses that have moved. Each of those is a source, asked in order and merged field by field, so a project adds one of its own without touching the resolver.

Requirements

PHP 8.3+, Laravel 13
webx-ui/module-admin, webx-ui/module-auth, webx-ui/module-settings, webx-ui/localization, webx-ui/mcp, webx-ui/routing

Install

composer require webx-ui/module-seo
php artisan migrate

The section appears once the front end lists it too: seo() from @webx-ui/module-seo in createAdmin({ modules: [...] }). Permissions: seo.view, seo.manage.

Printing the head

<head>
    @webxSeo
</head>

With an entity to name — once there is a source that answers about one:

@webxSeo($page)
{{-- or --}}
<x-webx-seo :for="$page" />

Both print <title>, the description, keywords and robots meta tags, the canonical link, the Open Graph properties and every JSON-LD block. What each of those is allowed to print is in config/webx-seo.php.

Where a value comes from

Sources are asked highest first and merged field by field, so a rule that fills in nothing but a title keeps the description and the picture that came from below it.

Priority	Source	Reads
100	`UrlRuleSource`	`seo_urls` — the rules written for addresses
50	`EntitySource`	`seo_meta` — what the page's entity says
10	`DefaultsSource`	`settings('seo.*')`

A project adds its own by implementing SeoSource and registering it:

app(SeoSources::class)->register(new MySource);

An entity that speaks for itself

use WebxUi\Seo\HasSeo;

class Page extends Model
{
    use HasSeo;
}

One row of seo_meta per entity, translated. $page->seoValue() and $page->saveSeo() read and write it, $page->seoData($locale) is what it contributes to the <head>. An entity with no row contributes nothing, which is what lets the site's defaults through. The card itself is one node of type wx-seo, put on the entity's screen by a patch.

Matching an address

One matcher serves rules and redirects alike. What is compared is the path with its query string, as it arrived — /catalog/shoes?page=2 — with a trailing slash removed from anything but the root.

exact — that address and no other.
mask — * is a stretch without a slash, ** is a stretch with them. A redirect target may name what was captured: /catalog/* → /shop/$1.
regex — stored as written, delimiters and all, and checked when it is saved. A pattern that will not compile never matches; it cannot take the public side down.

Rules are tried exact first, then mask, then regex; inside a group by priority descending. The first match wins. The active ones are kept as one compiled list in the cache, thrown away whenever any of them is saved or deleted.

`robots` and `robots.txt` are different things

robots on a rule is that page's own meta directives — noindex, nofollow — printed into <meta name="robots">.
seo.robots-txt is one setting for the whole site, served at /robots.txt.

If a real public/robots.txt exists, the web server hands it over before Laravel is asked, and the setting never gets a say. That is the server doing its job, not a bug in this package.

The settings tab

The module lays a patch over settings.index. The ids below are a contract: a project writes its own patch against them.

id	type	name
`seo`	`wx-tab`
`seo-card`	`wx-card`
`default-og`	`wx-media`	`seo.default-og`
`title-template`	`wx-input`	`seo.title-template`
`robots-txt`	`wx-textarea`	`seo.robots-txt`
`org-name`	`wx-input`	`seo.org-name`
`org-logo`	`wx-media`	`seo.org-logo`
`org-socials`	`wx-repeater`	`seo.org-socials`

The dot in seo.default-og is part of the name, not a path.

API

Under config('webx-admin.api_path').'/seo':

Method and address	What it does
`GET /urls`	the rules, in the order the site tries them
`POST /urls`	add one
`GET`, `PUT`, `DELETE` on `/urls/{id}`	one rule
`GET /redirects` …	the same for redirects
`GET /aliases`	the addresses renames left behind; read only
`POST /test-url`	what an address ends up saying, and where each part is from

test-url is the one worth remembering: it answers "why does this page have the wrong title" in one call — and says what webx-ui/routing holds at the address, which is how the panel warns that a redirect is about to shadow a live page.

/aliases is the other half of the redirects: the trail a rename leaves in the address registry, read through its RouteAliases contract. Nothing writes there — those rows belong to the entity that moved.

Structured data

Three levels, on purpose:

About the site — Organization, WebSite — comes from the settings fields, and the JSON-LD is assembled from them.
About an entity — Article, Product, BreadcrumbList — is generated from the entity by the module that owns it. Typed in by hand it drifts away from the page within a month.
One-off exceptions — the JSON-LD field on a rule.

There is no schema.org builder in the panel and there will not be one: the vocabulary has hundreds of types and filling them in by hand is how markup starts lying.

License

MIT.

webx-ui / module-seo

Package info

Security

Statistics

README

Requirements

Install

Printing the head

Where a value comes from

An entity that speaks for itself

Matching an address

`robots` and `robots.txt` are different things

The settings tab

API

Structured data

License

webx-ui / module-seo

Package info

Security

Statistics

README

Requirements

Install

Printing the head

Where a value comes from

An entity that speaks for itself

Matching an address

robots and robots.txt are different things

The settings tab

API

Structured data

License

`robots` and `robots.txt` are different things