---
id: gk-foundation-onboarding-home
title: "Filter - gk/foundation/onboarding/home"
sidebar_label: "gk/foundation/onboarding/home"
---

# Filter: gk/foundation/onboarding/home

Filters the site-level content of the shared Welcome page: how the product catalog read went, how many GravityKit products are installed, one editorial story and up to three featured products.

## Parameters

| Name | Type | Description |
|------|------|-------------|
| $home | `array\|null` | Site-level content. Default: null, which tells the page the catalog is unavailable. |
| ↳ $catalog | `string` | One of 'ready', 'unavailable' or 'restricted'. Default: 'unavailable'. |
| ↳ $installed | `int` | GravityKit products installed on this site. Meaningful only when catalog is 'ready'. Default: 0. |
| ↳ $news | `array\|null` | One story: category, title, description, url and image \{ url, alt |
| ↳ $featured | `array` | Up to three products with slug, name, description, icon and url. Default: empty. |

### Since

- TBD: TBD

### Source

Defined in `Onboarding/Framework.php` at line 752