X

Content

Learn how to work with content in your frontend templates.

Content Helper

The inspirecms_content() helper provides access to content items throughout your frontend templates:

// Get content by ID
$modelContent = inspirecms_content()->findByIds(ids: '550e8400-e29b-41d4-a716-446655440000', limit: 1)->first();

// Get content by slug
$modelContent = inspirecms_content()->findByRealPath(path: 'about-us', limit: 1)->first();

// Get multiple content items
$modelContents = inspirecms_content()->findByIds(['550e8400-e29b-41d4-a716-446655440000', '7f1b96c0-d4f0-11ed-afa1-0242ac120002']);

// Get published content under 'home'
$modelContents = inspirecms_content()->getUnderRealPath(path: 'home', isPublished: true);

// Get paginated published content under 'home'
$modelContents = inspirecms_content()->getPaginatedUnderRealPath(path: 'home', isPublished: true, page: 1, perPage: 10);

// Get content by document type
$modelContents = inspirecms_content()->getByDocumentType(documentType: 'blog-post', isPublished: true);

// Get paginated content by document type
$modelContents = inspirecms_content()->getPaginatedByDocumentType(documentType: 'blog-post', isPublished: true, page: 1, perPage: 10);
NOTE

These functions return Content model instances. To access content properties and use them in templates, convert the model to a DTO using the toDto() method:

$contentDto = $moedlContent->toDto($locale ?? app()->getLocale());

$title = $contentDto->getTitle();

Accessing ContentDTO Properties

Basic Properties

Access core content attributes:

$title = $contentDto->getTitle();          // Get content title
$slug = $contentDto->slug;                 // Get content slug
$url = $contentDto->getUrl();              // Get content URL
$locale = $contentDto->getLocale();        // Get content locale
$publishedAt = $contentDto->publishAt;     // Publication date

Custom Fields

Use property directives in Blade templates to access custom fields:

// Single property
<h1>@property('hero', 'title')</h1>

// With custom variable name
@property('hero', 'images', 'custom_images')
@foreach($custom_images ?? [] as $image)
    <img src="{{ $image->getUrl() }}">
@endforeach

// Value is from $blogDTO, variable available as $blog_category
@property('blog', 'category', null, $blogDTO)

// Array properties
@propertyArray('gallery', 'images')
@foreach($gallery_images ?? [] as $image)
    <img src="{{ $image->getUrl() }}" alt="{{ $image->alt_text }}">
@endforeach

// Conditional display
@propertyNotEmpty('hero', 'button_text')
    <a href="@property('hero', 'button_link')" class="btn">
        {{ $hero_button_text }}
    </a>
@endif

You can also access properties programmatically:

// Check if property exists
if ($contentDto->hasProperty('hero', 'title')) {
    // Get property value
    $title = $contentDto->getPropertyValue('hero', 'title');

    // Get property value with fallback
    $subtitle = $contentDto->getPropertyValue('hero', 'subtitle') ?? 'Default subtitle';

    // Get multilingual property with specific locale
    $frenchTitle = $contentDto->getPropertyValue('hero', 'title', 'fr');
}

// Check if property group exists
if ($content->hasPropertyGroup('hero')) {
    // Get entire property group
    $heroGroup = $contentDto->getPropertyGroup('hero');
}

Content Relationships

Access related content and structure:

// Get parent contentDTO
$parent = $contentDto->getParent();

// Get all child contentDTO
$children = $contentDto->getChildren();

// Get paginated child contentDTO (After v1.1.x)
$paginator = $contentDto->getPaginatedChildren(page: 1, perPage: 15, pageName: 'page2', isWebPage: true, isPublished: true, sorting: ['__latest_version_publish_dt' => 'desc'])

// Get ancestors in hierarchical order
$ancestors = $contentDto->getAncestors();

Content Filtering and Sorting

Filter and sort content collections:

// Get recent blog posts
$modelContents = inspirecms_content()->getUnderRealPath(
    path: 'blogs',
    isPublished: true,
    sorting: ['__latest_version_publish_dt' => 'desc'],
    limit: 5,
);

// Get paginated recent blog posts
$modelContents = inspirecms_content()->getPaginatedUnderRealPath(
    path: 'blogs',
    page: 1,
    perPage: 10,
    isPublished: true,
    sorting: ['__latest_version_publish_dt' => 'desc'],
);

// Filter by custom fields
$dtoContents = inspirecms_content()->getByDocumentType(
        documentType: 'blog_post',
        limit: 50,
    )
    ->toDto($locale ?? app()->getLocale())
    ->filter(function($post) {
        return $post->getPropertyValue('blog', 'is_featured') === true;
    });

Working with Multiple Languages

Access content in different languages:

// Get content in specific language
$frenchContentDto = $modelContent->toDto('fr');

// Loop through all available translations
foreach (inspirecms()->getAllAvailableLanguages() as $locale => $langDto) {
    $translatedTitle = $contentDto->getTitle($locale);
    // Do something with the translation
}

Pagination

Paginate content collections:

// In your controller
$paginatedContentDto = inspirecms_content()->getPaginatedByDocumentType(documentType: 'post-page', perPage: 10)->toDto();

// In your Blade template
@foreach ($paginatedContentDto as $post)
    <h2>{{ $post->getTitle() }}</h2>
    <p>{{ $post->getPropertyValue('blog', 'excerpt') }}</p>
@endforeach

{{ $paginatedContentDto->links() }}

Best Practices

  • Use inspirecms_content() helper for retrieving content instead of direct database queries
  • Always check if properties exist before using them
  • Cache frequent content queries for better performance
  • For large content sets, use pagination to improve page load times
  • Use property directives in Blade templates for cleaner syntax
NOTE

For examples of displaying content in layouts, see the Layouts documentation.

Previous
Next