---
url: /foehn-framework/api.md
---
# API Reference

This section documents all attributes, interfaces, and core classes in Føhn.

## Attributes

Attributes are PHP 8 annotations that enable auto-discovery and registration of WordPress components.

### Hooks

| Attribute                          | Description                      |
| ---------------------------------- | -------------------------------- |
| [`#[AsAction]`](./as-action)       | Register a WordPress action hook |
| [`#[AsFilter]`](./as-filter)       | Register a WordPress filter hook |
| [`#[AsShortcode]`](./as-shortcode) | Register a shortcode handler     |

### Content Types

| Attribute                               | Description                                |
| --------------------------------------- | ------------------------------------------ |
| [`#[AsPostType]`](./as-post-type)       | Register a custom post type                |
| [`#[AsPostMeta]`](./as-post-meta)       | Register a meta key, with a REST schema    |
| [`#[AsTaxonomy]`](./as-taxonomy)        | Register a custom taxonomy                 |
| [`#[AsMenu]`](./as-menu)                | Register a navigation menu location        |
| [`#[AsTimberModel]`](./as-timber-model) | Map Timber class without type registration |

### Media

| Attribute                           | Description                  |
| ----------------------------------- | ---------------------------- |
| [`#[AsImageSize]`](./as-image-size) | Register a custom image size |

### Views

| Attribute                                             | Description                    |
| ----------------------------------------------------- | ------------------------------ |
| [`#[AsContextProvider]`](./as-context-provider)       | Add data to specific templates |
| [`#[AsTemplateController]`](./as-template-controller) | Handle template rendering      |

### Twig

| Attribute                                   | Description               |
| ------------------------------------------- | ------------------------- |
| [`#[AsTwigExtension]`](./as-twig-extension) | Register a Twig extension |

### Blocks

| Attribute                                    | Description                       |
| -------------------------------------------- | --------------------------------- |
| [`#[AsBlock]`](./as-block)                   | Register a native Gutenberg block |
| [`#[AsAcfBlock]`](./as-acf-block)            | Register an ACF block             |
| [`#[AsAcfFieldGroup]`](./as-acf-field-group) | Register an ACF field group       |
| [`#[AsBlockPattern]`](./as-block-pattern)    | Register a block pattern          |
| [`#[AsBlockCategory]`](./as-block-category)  | Register a block category         |
| [`#[AsBlockBinding]`](./as-block-binding)    | Register a block bindings source  |

### ACF

| Attribute                                      | Description                  |
| ---------------------------------------------- | ---------------------------- |
| [`#[AsAcfOptionsPage]`](./as-acf-options-page) | Register an ACF options page |

### Settings

| Attribute                                 | Description                                 |
| ----------------------------------------- | ------------------------------------------- |
| [`#[AsSettingsPage]`](./as-settings-page) | An admin page on the WordPress Settings API |

### API & CLI

| Attribute                               | Description                            |
| --------------------------------------- | -------------------------------------- |
| [`#[AsRestRoute]`](./as-rest-route)     | Register a REST API endpoint           |
| [`#[AsRewriteRule]`](./as-rewrite-rule) | Register a rewrite rule, and answer it |
| [`#[AsCliCommand]`](./as-cli-command)   | Register a WP-CLI command              |

## Interfaces

Interfaces define contracts for classes used with specific attributes.

| Interface                                                              | Used with                        |
| ---------------------------------------------------------------------- | -------------------------------- |
| [`BlockInterface`](./block-interface)                                  | `#[AsBlock]`                     |
| [`InteractiveBlockInterface`](./interactive-block-interface)           | `#[AsBlock]` with interactivity  |
| [`AcfBlockInterface`](./acf-block-interface)                           | `#[AsAcfBlock]`                  |
| [`AcfFieldGroupInterface`](./acf-field-group-interface)                | `#[AsAcfFieldGroup]`             |
| [`AcfOptionsPageInterface`](./acf-options-page-interface)              | `#[AsAcfOptionsPage]` (optional) |
| [`ContextProviderInterface`](./context-provider-interface)             | `#[AsContextProvider]`           |
| [`TemplateControllerInterface`](./template-controller-interface)       | `#[AsTemplateController]`        |
| [`RewriteHandlerInterface`](./as-rewrite-rule#rewritehandlerinterface) | `#[AsRewriteRule]` (optional)    |
| [`BlockPatternInterface`](./block-pattern-interface)                   | `#[AsBlockPattern]` (optional)   |

## Configuration

| Config Class                      | Config File             | Description              |
| --------------------------------- | ----------------------- | ------------------------ |
| [`FoehnConfig`](./foehn-config)   | `app/foehn.config.php`  | Core bootstrap settings  |
| [`TimberConfig`](./timber-config) | `app/timber.config.php` | Template directories     |
| [`AcfConfig`](./acf-config)       | `app/acf.config.php`    | ACF field transformation |
| [`RestConfig`](./rest-config)     | `app/rest.config.php`   | REST API permissions     |

## Discovery

| Class                                            | Description                      |
| ------------------------------------------------ | -------------------------------- |
| [`DiscoveryRunner`](./discovery-runner)          | Orchestrates discovery lifecycle |
| [`#[AsDiscovery]`](./as-discovery)               | Declares a discovery's phase     |
| [`ViewEngineInterface`](./view-engine-interface) | View rendering abstraction       |

## Core

| Class                                   | Description              |
| --------------------------------------- | ------------------------ |
| [`Kernel`](./kernel)                    | Main bootstrap class     |
| [`Helpers`](./helpers)                  | Global helper functions  |
| [`CacheInterface`](./cache-interface)   | Injectable cache service |
| [`WebpackManifest`](./webpack-manifest) | Asset manifest helper    |

## DTOs & Traits

| Class / Trait                            | Description                          |
| ---------------------------------------- | ------------------------------------ |
| [`Arrayable`](./arrayable)               | Interface for DTO → array conversion |
| [`HasToArray`](./has-to-array)           | Reflection-based `toArray()` trait   |
| [`LinkData`](./data-dtos#linkdata)       | DTO for link/button fields           |
| [`ImageData`](./data-dtos#imagedata)     | DTO for image/attachment fields      |
| [`SpacingData`](./data-dtos#spacingdata) | DTO for spacing fields               |

## Query

| Class                                      | Description                   |
| ------------------------------------------ | ----------------------------- |
| [`PostQueryBuilder`](./post-query-builder) | Fluent post query builder     |
| [`QueriesPostType`](./queries-post-type)   | Trait for model query methods |