Site Picker

The sitePicker component provides tools for working with Multisite configuration for your website. The best place to include this is in your page or layout template.

# Basic Usage

[sitePicker]

{% set availableSites = sitePicker.sites %}

The following is an example of displaying a dropdown that switches between sites. It is used in conjunction with the this.site Twig property.

<select class="form-control" onchange="window.location.assign(this.value)">
    {% for site in sitePicker.sites %}
        <option value="{{ site.url }}" {{ this.site.code == site.code ? 'selected' }}>
            {{ site.name }}
        </option>
    {% endfor %}
</select>

Another example is generating alternative page links using meta tags

{% for site in sitePicker.sites %}
    <link rel="alternate" hreflang="{{ site.locale }}" href="{{ site.url }}" />
{% endfor %}

# Loading Sites for a Different Page

By default, the sites property will return sites configured for the current page and the url will resolve to the current page. The pageSites() function can be used to locate sites for a different page, where the first argument is the CMS page name.

In the example below, each site will have a url set to the CMS page found in pages/blog/index.htm. If the page is not found, then the result will be an empty array.

[sitePicker]

{% set otherSites = sitePicker.pageSites('blog/index') %}

# Translating URL Parameters

By default, the sitePicker component isn't aware of model parameters in the URL, such as page slugs and identifiers. The cms.sitePicker.overrideParams global event is used to override the URL parameters to their translated versions. A good place to put this event is inside the init or the onRun method of a CMS Component class.

# Using the Multisite Trait

If the model implements the Multisite trait, each site has a separate record with its own slug. The newOtherSiteQuery method is used to locate the model for the proposed site and modify the URL parameters.

$myModel = MyModel::find(1);
$otherModels = $myModel->newOtherSiteQuery()->get();

Event::listen('cms.sitePicker.overrideParams', function($page, $params, $currentSite, $proposedSite) use ($otherModels) {
    $otherModel = $otherModels->where('site_id', $proposedSite->id)->first();
    if ($otherModel) {
        $params['id'] = $otherModel->id;
        $params['slug'] = $otherModel->slug;
        $params['fullslug'] = $otherModel->fullslug;
    }
    return $params;
});

# Using the Translatable Trait

If the model implements the Translatable trait, there is a single record with translated attributes. The getTranslation method retrieves the slug for the proposed locale.

$myModel = MyModel::find(1);

Event::listen('cms.sitePicker.overrideParams', function($page, $params, $currentSite, $proposedSite) use ($myModel) {
    $proposedLocale = $proposedSite->hard_locale;
    $params['slug'] = $myModel->getTranslation('slug', $proposedLocale);
    return $params;
});

# Translating Query String Parameters

The cms.sitePicker.overrideQuery global event works the same way as cms.sitePicker.overrideParams but applies to query string parameters instead of URL route parameters. This is useful when model identifiers or filters are passed via the query string.

Event::listen('cms.sitePicker.overrideQuery', function($page, $params, $currentSite, $proposedSite) {
    // Modify $params and return the translated query string values
    return $params;
});

# See Also