Sage Directives

https://github.com/log1x/sage-directives
Admin
Sage Directives adds useful Blade directives for Sage 10 including WordPress, ACF, and miscellaneous...
Tokens:29,989
Snippets:323
Trust Score:9.5
License:MIT
Update:1 week ago
Show doc for...
Tokens:
Raw
### Build Documentation with Yarn

Source: https://github.com/log1x/sage-directives/blob/master/README.md

Builds the documentation site. Requires Yarn to be installed.

```bash
$ yarn install
$ yarn run docs:build
```

--------------------------------

### Install Sage Directives via Composer

Source: https://github.com/log1x/sage-directives/blob/master/README.md

Installs the Sage Directives package using Composer. Requires Sage >= 10.0, PHP >= 8.1, and Composer.

```bash
$ composer require log1x/sage-directives
```

--------------------------------

### @stylesheet - Inline CSS or link to stylesheet

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/helpers.md

Allows quick inlining of a CSS block (closed with @endstylesheet) or defining a path to a stylesheet. The example shows both usages.

```php
@stylesheet
  .button {
    background-color: LightGreen;
    color: white;
    padding: 0.75rem 1rem;
  }
@endstylesheet

@stylesheet('/path/to/style.css')
```

--------------------------------

### @script - Inline JavaScript or link to script

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/helpers.md

Allows quick inlining of a JavaScript block (closed with @endscript) or defining a path to a script. The example shows both usages.

```php
@script
  console.log('Hello World')
@endscript

@script('/path/to/script.js')
```

--------------------------------

### @option directive with array key

Source: https://github.com/log1x/sage-directives/wiki/Advanced-Custom-Fields

If the option is an array, pass the key as a second parameter. Example shows a logo image.

```php
<div class="navbar-brand">
  <a class="navbar-item" href="{{ home_url() }}">
    <img src="@option('logo', 'url')" alt="{{ get_bloginfo('name', 'display') }}" />
  </a>
</div>
```

--------------------------------

### @postmeta variations

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Gets post meta using get_post_meta. First argument is the key, optional second is post_id, optional third controls the $single bool.

```php
@postmeta('key')
@postmeta('key', 1)
@postmeta(1)
@postmeta('key', 1, true)
```

--------------------------------

### @implode - Join array elements with a glue string

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/helpers.md

Echoes a string containing a representation of each element in the array, separated by the glue string. The example outputs 'dog, cat, mouse, snake'.

```php
@implode(', ' ['dog', 'cat', 'mouse', 'snake'])
// dog, cat, mouse, snake
```

--------------------------------

### @hasoption with array key

Source: https://github.com/log1x/sage-directives/wiki/Advanced-Custom-Fields

Pass an array key as a second parameter to check a specific subfield. Example shows a Facebook icon or label.

```php
@hasoption('facebook', 'url')
  <a href="@option('facebook', 'url')" target="_blank">
    @hasoption('facebook', 'icon')
      <span class="icon">
        <i class="fas @option('facebook', 'icon')"></i>
      </span>
    @else 
      <span class="label">Facebook</span>
    @endoption
  </a>
@endoption
```

--------------------------------

### @option directive for theme options

Source: https://github.com/log1x/sage-directives/wiki/Advanced-Custom-Fields

Echoes a theme options field using get_field($field, 'option'). Example shows a Facebook link.

```php
Find us on <a href="@option('facebook_url')" target="_blank">Facebook</a>
```

--------------------------------

### @menu directive with @hasmenu wrapper

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Calls wp_nav_menu() and is typically wrapped in @hasmenu and @endhasmenu. The example passes the 'primary_navigation' theme location.

```php
@hasmenu('primary_navigation')
  @menu(['theme_location' => 'primary_navigation'])
@endhasmenu
```

--------------------------------

### Conditional check with @hassub and @endsub

Source: https://github.com/log1x/sage-directives/wiki/Advanced-Custom-Fields

Use @hassub to check if a sub field exists and is not empty. Close with @endsub. This example outputs an icon if the field is set.

```php
@hassub('icon')
  <i class="fas fa-@sub('icon')"></i>
@endsub
```

--------------------------------

### Echo sub field array key with @sub

Source: https://github.com/log1x/sage-directives/wiki/Advanced-Custom-Fields

When the sub field is an array, pass the key as a second parameter to @sub. This example outputs image URL and alt text.

```php
<ul class="slider">
  @fields('slides')
    <li class="slide">
      <img src="@sub('image', 'url')" alt="@sub('image', 'alt')" />
    </li>
  @endfields
</ul>
```

--------------------------------

### @authorurl

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Echoes the archive URL for the current post's author. Optionally accepts an author ID to get a specific author's archive URL.

```APIDOC
## @authorurl

### Description
Echoes the archive URL for the current post's author. Optionally accepts an author ID to get a specific author's archive URL.

### Usage
`@authorurl` - Echoes the current post's author archive URL.
`@authorurl(2)` - Echoes the archive URL for the author with ID 2.

### Parameters
- **author ID** (int) - Optional - The ID of the author whose archive URL to echo.

### Example
```php
<a href="@authorurl" itemprop="url">@author</a>
<a href="@authorurl(2)">@author</a>
```
```

--------------------------------

### @js - Declare inline JavaScript variables

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/helpers.md

Declares inline JavaScript variables similar to wp_add_inline_script(). The passed value can be a string or an array. The example outputs a script tag with window.hello = 'world'.

```php
@js('hello', 'world')

// <script>
//   window.hello = 'world';
// </script>
```

--------------------------------

### Conditional check with @issub on array key and value

Source: https://github.com/log1x/sage-directives/wiki/Advanced-Custom-Fields

For array sub fields, pass the array key as second parameter and the value to check as third parameter to @issub. This example checks if the 'name' key equals 'arrow'.

```php
@issub('icon', 'name', 'arrow')
  <i class="fas fa-@sub('icon', 'value') fa-rotate-90"></i>
@endsub
```

--------------------------------

### Conditional check with @hassub on array key

Source: https://github.com/log1x/sage-directives/wiki/Advanced-Custom-Fields

When checking an array sub field, pass the array key as a second parameter to @hassub. This example checks the 'url' key of an image field.

```php
@hassub('image', 'url')
  <img src="@sub('image', 'url')" alt="@sub('image', 'alt')" />
@endsub
```

--------------------------------

### Conditional check with @issub and @endsub

Source: https://github.com/log1x/sage-directives/wiki/Advanced-Custom-Fields

Use @issub to check if a sub field equals a specified value. Close with @endsub. This example checks if the icon field equals 'arrow'.

```php
@issub('icon', 'arrow')
  <i class="fas fa-arrow-up fa-rotate-90"></i>
@endsub
```

--------------------------------

### @extract with @include workflow

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/helpers.md

Extracts the passed array into variables. Useful for making views customizable when passing parameters to @include while having default values set within the view. The example shows a single.blade.php including entry-meta.blade.php, which uses @extract to merge passed parameters with defaults.

```php
// single.blade.php
@include('components.entry-meta', [
  'author' => false,
  'date'   => true,
])
```

```php
// entry-meta.blade.php
@extract([
  'author' => $author ?? true,
  'date'   => $date   ?? true
])

@if ($author)
  [...]
@endif

@if ($date)
  [...]
@endif
```

--------------------------------

### @authorurl directive

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Echoes the archive URL of the current post's author. Pass an author ID to get a specific author's URL. The example shows usage within HTML markup.

```php
<span class="author" itemprop="author" itemscope itemtype="http://schema.org/Person">
  <a href="@authorurl" itemprop="url">
    <span class="fn" itemprop="name" rel="author">@author</span>
  </a>
</span>
```

```php
<a href="@authorurl(2)">@author</a>
```

--------------------------------

### @query

Source: https://github.com/log1x/sage-directives/wiki/WordPress

Initializes a standard WP_Query as $query and accepts WP_Query parameters as an array. This directive sets up the query for use with @posts.

```APIDOC
## @query

### Description
Initializes a standard WP_Query as $query and accepts the usual WP_Query parameters as an array.

### Parameters
#### Array Parameters
- **WP_Query parameters** (array) - Required - An array of WP_Query parameters, e.g., ['post_type' => 'post']

### Example
```php
@query([
  'post_type' => 'post'
])
```
```

--------------------------------

### @shortcode

Source: https://github.com/log1x/sage-directives/wiki/WordPress

Echoes the specified shortcode using do_shortcode().

```APIDOC
## @shortcode

### Description
Echoes the specified shortcode using do_shortcode().

### Parameters
#### Required Parameters
- **shortcode** (string) - Required - The shortcode to echo, e.g., '[my-shortcode]'

### Example
```php
@shortcode('[my-shortcode]')
```
```

--------------------------------

### @notempty with second parameter

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/helpers.md

Alternative syntax that passes the output as a second parameter to @notempty.

```php
@notempty($variable, 'There is something here.')
```

--------------------------------

### Apply wpautop with @wpautop

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Runs the passed string through wpautop() and echoes the output.

```php
@wpautop($content)
```

--------------------------------

### @field directive - echo field value

Source: https://github.com/log1x/sage-directives/wiki/Advanced-Custom-Fields

Echoes the value of a specified ACF field using get_field(). Requires ACF to be installed and activated.

```php
@field('text')
```

--------------------------------

### @query

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Initializes a standard WP_Query as $query and accepts WP_Query parameters as an array.

```APIDOC
## @query

### Description
Initializes a standard `WP_Query` as `$query` and accepts the usual `WP_Query` parameters as an array.

### Usage
```php
@query([
  'post_type' => 'post'
])
```

### Parameters
- **parameters** (array) - Required - An array of `WP_Query` parameters.
```

--------------------------------

### Echo shortcode with @shortcode

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Outputs the result of do_shortcode() for the given shortcode string.

```php
@shortcode('[my-shortcode]')
```

--------------------------------

### @excerpt

Source: https://github.com/log1x/sage-directives/wiki/WordPress

Echoes the current post's excerpt using the_excerpt().

```APIDOC
## @excerpt

### Description
Echoes the current post's excerpt using the_excerpt().

### Example
```php
@excerpt
```
```

--------------------------------

### Apply wpautop and sanitize with @wpautokp

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Runs the passed string through wpautop() and sanitizes it with wp_kses_post(), then echoes the output.

```php
@wpautokp($content)
```

--------------------------------

### @fields

Source: https://github.com/log1x/sage-directives/wiki/Advanced-Custom-Fields

A Blade directive that simplifies handling ACF repeater fields. It wraps the `have_rows()` conditional and starts the loop with `the_row()`. Can be closed with `@endfields`.

```APIDOC
## @fields

### Description
Helper for handling repeater fields. It checks if the field exists and is not empty, then begins the while loop and calls `the_row()`. Can be closed with `@endfields`.

### Usage
```php
@fields('field_name')
  <!-- loop content -->
@endfields
```

### Parameters
- **field_name** (string) - Required - The ACF repeater field name.
- **post_id** (int) - Optional - The post ID to retrieve the fields from.

### Examples
Basic usage:
```php
<ul>
  @fields('list')
    <li>@sub('item')</li>
  @endfields
</ul>
```

With post ID:
```php
<ul>
  @fields('list', 1)
    <li>@sub('item')</li>
  @endfields
</ul>
```
```

--------------------------------

### @content

Source: https://github.com/log1x/sage-directives/wiki/WordPress

Echoes the current post's content using the_content().

```APIDOC
## @content

### Description
Echoes the current post's content using the_content().

### Example
```php
@content
```
```

--------------------------------

### @wpautokp

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Runs a passed string through wpautop() and sanitizes it with wp_kses_post(). Echoes the output.

```APIDOC
## @wpautokp

### Description
Runs a passed string through `wpautop()` and sanitizes it with `wp_kses_post()`. Echoes the output.

### Usage
```php
@wpautokp($content)
```

### Parameters
- **content** (string) - Required - The string to process and sanitize.
```

--------------------------------

### @query directive: Initialize WP_Query

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Initializes a standard WP_Query as $query with the given parameters array. Accepts usual WP_Query parameters.

```php
@query([
  'post_type' => 'post'
])
```

--------------------------------

### @hasfield directive - conditional field check

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/acf.md

Checks if the specified field exists and is not empty. Must be closed with @endfield. The example shows using @fields and @sub inside the block.

```php
@hasfield('list')
  <ul>
    @fields('list')
      <li>@sub('item')</li>
    @endfields
  </ul>
@endfield
```

--------------------------------

### @shortcode

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Echoes the specified shortcode using WordPress's do_shortcode() function. Pass the shortcode string as an argument.

```APIDOC
## @shortcode

### Description
Echoes the specified shortcode using WordPress's `do_shortcode()` function.

### Usage
```php
@shortcode('[my-shortcode]')
```

### Parameters
- **shortcode** (string) - Required - The shortcode string to echo.
```

--------------------------------

### @wpautop

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Runs a passed string through WordPress's wpautop() function and echoes the output.

```APIDOC
## @wpautop

### Description
Runs a passed string through WordPress's `wpautop()` function and echoes the output.

### Usage
```php
@wpautop($content)
```

### Parameters
- **content** (string) - Required - The string to process.
```

--------------------------------

### Use @inline to load a CSS file inline

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/helpers.md

Loads the contents of a CSS, JS, or HTML file inline into the view, wrapping the content with the proper HTML tag based on the file extension. The path defaults to the current theme directory.

```php
@inline('dist/styles/critical.css')
```

--------------------------------

### @hassub with multiple array keys

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/acf.md

Checks if the sub field 'image' with keys 'sizes' and 'thumbnail' exists and is not empty.

```php
@hassub('image', 'sizes', 'thumbnail')
  <img src="@sub('image', 'sizes', 'thumbnail')" alt="@sub('image', 'alt')" />
@endsub
```

--------------------------------

### @isnotnull with second parameter

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/helpers.md

Passes the output as a second parameter to @isnotnull.

```php
@isnotnull($variable, 'There is something here.')
```

--------------------------------

### @group directive for grouped fields

Source: https://github.com/log1x/sage-directives/wiki/Advanced-Custom-Fields

Use @group to handle grouped ACF fields, similar to @fields. It can be closed with @endgroup. The example shows a button group with subfields.

```php
@group('button')
  @hassub('url')
    <a href="@sub('url')" class="button button--@sub('color')">
      @sub('label')
    </a>
  @endsub
@endgroup
```

--------------------------------

### @repeat with $loop variable - Access loop metadata

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/helpers.md

Shows how to use $loop->first, $loop->last, $loop->iteration, $loop->count, $loop->remaining, and $loop->index inside a @repeat block.

```php
@repeat(5)
  @if ($loop->first)
    This is the first iteration.
  @endif

  @if ($loop->last)
    This is the last iteration.
  @endif

  This is iteration {{ $loop->iteration }} out of $loop->count.
  There are {{ $loop->remaining }} iterations left.
  The current iteration index is {{ $loop->index }}
@endrepeat
```

--------------------------------

### @hasfield directive - check field for specific post

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/acf.md

Checks the existence of a field for a specific post by passing a post ID as the second parameter. Note the closing tag is @endfield (not @endfields) in this example.

```php
@hasfield('list', 5)
  <ul>
    @fields('list', 5)
      <li>@sub('item')</li>
    @endfield
  </ul>
@endfield
```

--------------------------------

### @posts

Source: https://github.com/log1x/sage-directives/wiki/WordPress

Begins the post loop, defaulting to the $query variable set by @query. It is wrapped in a have_posts() conditional and returns null if no posts are found. Can accept a WP_Query instance, a post ID, a post object, or an array of IDs/objects.

```APIDOC
## @posts

### Description
Begins the post loop and by default assumes WP_Query is set to $query. It is wrapped in a have_posts() conditional and returns null if no posts are found. Can accept a WP_Query instance, a post ID, a post object, or an array of IDs/objects.

### Parameters
#### Optional Parameters
- **$query** (WP_Query|int|WP_Post|array) - Optional - A WP_Query instance, post ID, post object, or array of IDs/objects. If not provided, uses the main loop from $wp_query global.

### Closing Directive
- **@endposts** - Ends the loop and have_posts() conditional, and resets the loop with wp_reset_postdata().

### Examples
```php
@query([
  'post_type' => 'post'
])

@posts
  <h2 class="entry-title">@title</h2>
  <div class="entry-content">
    @content
  </div>
@endposts
```

```php
@php
  $query = new WP_Query([
    'post_type' => 'post'
  ]);
@endphp

@posts($query)
  <h2 class="entry-title">@title</h2>
  <div class="entry-content">
    @content
  </div>
@endposts
```

```php
@posts(12)
  <h2 class="entry-title">@title</h2>
  <div class="entry-content">
    @content
  </div>
@endposts
```

```php
@posts(get_post(4))
  <h2 class="entry-title">@title</h2>
  <div class="entry-content">
    @content
  </div>
@endposts
```

```php
@posts([6, get_post(9), 3])
  <h2 class="entry-title">@title</h2>
  <div class="entry-content">
    @content
  </div>
@endposts
```
```

--------------------------------

### @isfalse with second parameter

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/helpers.md

Passes the output as a second parameter to @isfalse.

```php
@isfalse($variable, 'Goodbye World')
```

--------------------------------

### @stylesheet

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/helpers.md

Allows you to quickly inline a block of CSS or define a path to a stylesheet. When used for inline CSS, it can be closed using @endstylesheet.

```APIDOC
## @stylesheet

### Description
Allows you to quickly inline a block of CSS or define a path to a stylesheet. When used for inline CSS, it can be closed using @endstylesheet.

### Usage
Inline CSS:
```php
@stylesheet
  .button {
    background-color: LightGreen;
    color: white;
    padding: 0.75rem 1rem;
  }
@endstylesheet
```

Path to stylesheet:
```php
@stylesheet('/path/to/style.css')
```

### Parameters
- **path** (string) - Optional - The path to a stylesheet file. If provided, the directive will output a link to the stylesheet instead of inline CSS.

### Closing Tag
Use `@endstylesheet` to close the inline CSS block.
```

--------------------------------

### @hasfield directive - conditional field check

Source: https://github.com/log1x/sage-directives/wiki/Advanced-Custom-Fields

Checks if a field exists and is not empty. Must be closed with @endfield. The example shows using @fields and @sub to loop through a repeater field.

```php
@hasfield('list')
  <ul>
    @fields('list')
      <li>@sub('item')</li>
    @fields
  </ul>
@endfield
```

--------------------------------

### @layouts basic usage

Source: https://github.com/log1x/sage-directives/wiki/Advanced-Custom-Fields

Opens a loop over flexible content field 'components'. Must be closed with @endlayouts. Optionally pass a post ID as second parameter to target a specific post.

```php
@layouts('components')
  [...]
@endlayouts
```

--------------------------------

### @hasfield directive - check field for specific post

Source: https://github.com/log1x/sage-directives/wiki/Advanced-Custom-Fields

Checks if a field exists for a specific post by passing the post ID as the second parameter. The example shows using @fields and @sub to loop through a repeater field.

```php
@hasfield('list', 5)
  <ul>
    @fields('list', 5)
      <li>@sub('item')</li>
    @fields
  </ul>
@endfield
```

--------------------------------

### @excerpt

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Echoes the current post's excerpt using the_excerpt().

```APIDOC
## @excerpt

### Description
Echoes the current post's excerpt using the_excerpt().

### Usage
```php
@excerpt
```
```

--------------------------------

### @isnull with second parameter

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/helpers.md

Passes the output as a second parameter to @isnull.

```php
@isnull($variable, 'There is nothing here.')
```

--------------------------------

### @global directive

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/helpers.md

Globals the specified variable.

```php
@global($post)
```

--------------------------------

### @hasfield directive - check array field key

Source: https://github.com/log1x/sage-directives/wiki/Advanced-Custom-Fields

Checks if a specific key of an array field exists and is not empty by passing the array key as the second parameter. The example shows using @field to output the image URL and alt text.

```php
@hasfield('image', 'url')
  <figure class="image">
    <img src="@field('image', 'url')" alt="@field('image', 'alt')" />
  </figure>
@endfield
```

--------------------------------

### @guest

Source: https://github.com/log1x/sage-directives/wiki/WordPress

A simple ! is_user_logged_in() conditional to display content only when a user is not logged in. Can be closed with @endguest.

```APIDOC
## @guest

### Description
A simple ! is_user_logged_in() conditional to display content only when a user is not logged in.

### Closing Directive
- **@endguest** - Closes the conditional.

### Example
```php
@guest
  You must be <a href="/wp-login.php">logged in</a> to view this content.
@endguest
```
```

--------------------------------

### @action

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Triggers a WordPress action using do_action(). Pass the action hook name as a string.

```APIDOC
## @action

### Description
Triggers a WordPress action via do_action().

### Usage
```php
@action('get_footer')
```

### Parameters
- **hook** (string) - Required - The action hook name.
```

--------------------------------

### @hasfield directive - check array field key for specific post

Source: https://github.com/log1x/sage-directives/wiki/Advanced-Custom-Fields

Checks if a specific key of an array field exists for a specific post by passing the array key as the second parameter and the post ID as the third parameter. The example shows using @field to output the image URL and alt text for that post.

```php
@hasfield('image', 'url', 1)
  <figure class="image">
    <img src="@field('image', 'url', 1)" alt="@field('image', 'alt', 1)" />
  </figure>
@endfield
```

--------------------------------

### @content

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Echoes the current post's content using the_content().

```APIDOC
## @content

### Description
Echoes the current post's content using the_content().

### Usage
```php
@content
```
```

--------------------------------

### @postmeta

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Retrieves post meta for a post using get_post_meta(). Expects a key as the first argument, optional post_id as the second, and optional $single bool as the third.

```APIDOC
## @postmeta

### Description
Retrieves post meta for a post using get_post_meta(). Expects a key as the first argument, optional post_id as the second, and optional $single bool as the third.

### Parameters
- **key** (string) - Required - The meta key to retrieve.
- **post_id** (int) - Optional - The post ID to retrieve meta for.
- **$single** (bool) - Optional - Whether to return a single value.

### Usage
```php
@postmeta('key')
@postmeta('key', 1)
@postmeta(1)
@postmeta('key', 1, true)
```
```

--------------------------------

### @wpfooter

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Directive version of wp_footer(). Outputs the footer section of a WordPress theme.

```APIDOC
## @wpfooter

### Description
Directive version of wp_footer().

### Usage
```php
@wpfooter
```
```

--------------------------------

### @bodyclass

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Behaves like body_class(). Pass strings to add to the body class.

```APIDOC
## @bodyclass

### Description
Behaves like body_class().

### Usage
```php
@bodyclass('add-me')
```

### Parameters
- **class** (string) - Optional - Class to add to the body.
```

--------------------------------

### @istrue with second parameter

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/helpers.md

Passes the output as a second parameter to @istrue.

```php
@istrue($variable, 'Hello World')
```

--------------------------------

### @image directive: specify image size and alt tag

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Optionally pass an image size and an alt tag as the second and third parameters.

```php
@image(1, 'full', 'My alt tag')
```

--------------------------------

### @thumbnail - Echo featured image with specific size

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Pass a size as the only parameter, or as the second parameter when a post ID or WP_Post instance is present.

```php
@thumbnail('full')
@thumbnail(1, 'full')
@thumbnail(get_post(1), 'full')
```

--------------------------------

### @js

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/helpers.md

Allows you to declare inline Javascript variables similar to wp_add_inline_script(). The passed value can be in the form of a string or an array.

```APIDOC
## @js

### Description
Allows you to declare inline Javascript variables similar to wp_add_inline_script(). The passed value can be in the form of a string or an array.

### Usage
```php
@js('hello', 'world')

// <script>
//   window.hello = 'world';
// </script>
```

### Parameters
- **key** (string) - Required - The name of the JavaScript variable to declare.
- **value** (mixed) - Required - The value to assign to the variable. Can be a string or an array.

### Return Value
Outputs a script tag with the variable declaration.
```

--------------------------------

### @script

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/helpers.md

Allows you to quickly inline a block of Javascript or define a path to a script. When used for inline JS, it can be closed using @endscript.

```APIDOC
## @script

### Description
Allows you to quickly inline a block of Javascript or define a path to a script. When used for inline JS, it can be closed using @endscript.

### Usage
Inline JS:
```php
@script
  console.log('Hello World')
@endscript
```

Path to script:
```php
@script('/path/to/script.js')
```

### Parameters
- **path** (string) - Optional - The path to a script file. If provided, the directive will output a script tag with the source instead of inline JS.

### Closing Tag
Use `@endscript` to close the inline JS block.
```

--------------------------------

### @wpbodyopen

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Directive version of wp_body_open() that works on WordPress versions below 5.2.

```APIDOC
## @wpbodyopen

### Description
Directive version of wp_body_open().

### Usage
```php
@wpbodyopen
```
```

--------------------------------

### @categories as links

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Pass true as the first parameter (when used alone) or as the second parameter (when a post ID is present) to return the categories as links.

```php
@categories(true)
@categories(1, true)
```

--------------------------------

### @excerpt echo current post excerpt

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Echoes the current post's excerpt using the_excerpt().

```php
@excerpt
```

--------------------------------

### @terms

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Echoes a comma-separated list of the taxonomy terms of the current post. It accepts the same parameters as @term.

```APIDOC
## @terms

### Description
Echoes a comma-separated list of the taxonomy terms of the current post.

### Parameters
- **taxonomy** (string) - Required - The taxonomy name.
- **post_id** (int) - Optional - The post ID to get terms from.
- **link** (bool) - Optional - Whether to return terms as links.

### Usage Examples
```php
@terms('genre')
@terms('genre', 1)
@terms('genre', 1, true)
@terms('genre', true)
```
```

--------------------------------

### @category - Echo first category of current post

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Echoes the first category of the current post.

```php
@category
```

--------------------------------

### @posts

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Begins the post loop, assuming WP_Query is set to $query by default. It is wrapped in a have_posts() conditional and returns null if no posts are found. @endposts ends the loop and resets post data.

```APIDOC
## @posts

### Description
Begins the post loop, assuming `WP_Query` is set to `$query` by default. It is wrapped in a `have_posts()` conditional and returns `null` if no posts are found. `@endposts` ends the loop and resets post data.

### Usage
```php
@query([
  'post_type' => 'post'
])

@posts
  <h2 class="entry-title">@title</h2>
  <div class="entry-content">
    @content
  </div>
@endposts
```

### Parameters
- **query** (WP_Query|int|WP_Post|array) - Optional - A `WP_Query` instance, a post ID, a post object, or an array containing a mixture of these. If omitted, uses the main loop from the `$wp_query` global.
```

--------------------------------

### @postclass

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Functions like post_class() accepting an optional class and post ID.

```APIDOC
## @postclass

### Description
Functions like post_class().

### Usage
```php
@postclass
@postclass('bg-white')
@postclass('bg-white', $post->ID)
```

### Parameters
- **class** (string) - Optional - Class to add.
- **post_id** (int) - Optional - Post ID.
```

--------------------------------

### @category as link

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Pass true as a parameter to echo the category as a link.

```php
@category(true)
```

--------------------------------

### @categories

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Echoes a comma-separated list of the current post's categories. Can output as links and target a specific post.

```APIDOC
## @categories

### Description
Echoes a comma-separated list of categories for the current post, optionally as links, and optionally for a specific post.

### Usage
```php
@categories
@categories(1)
@categories(true)
@categories(1, true)
```

### Parameters
- **post** (int) - Optional - Post ID to get categories from.
- **link** (bool) - Optional - Whether to output categories as links (default false).

### Example
```php
@categories(1, true)
```
```

--------------------------------

### @notempty conditional with @endnotempty

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/helpers.md

Displays the enclosed output when the passed parameter exists and is not empty. Close with @endnotempty.

```php
@notempty($variable)
  There is something here.
@endnotempty
```

--------------------------------

### @guest

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Displays content only when a user is not logged in. Can be closed with @endguest.

```APIDOC
## @guest

### Description
Displays content only when a user is not logged in. Can be closed with @endguest.

### Usage
```php
@guest
  You must be <a href="/wp-login.php">logged in</a> to view this content.
@endguest
```
```

--------------------------------

### @options repeater/group loop with @hasoptions and @hassub

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/acf.md

Loops over repeater or group fields in theme options. Automatically passes the theme options ID 'option'. Closes with @endoptions. Used with @hasoptions to check for rows and @hassub to check sub-fields.

```php
@hasoptions('social')
  <ul class="social">
    @options('social')
      <li>
        <a href="@sub('url')" target="_blank">
          @hassub('icon')
            <span class="icon">
              <i class="fas fa-@sub('icon')"></i>
            </span>
          @endsub
          <span>@sub('platform')</span>
        </a>
      </li>
    @endoptions
  </ul>
@endhasoptions
```

--------------------------------

### @wphead

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Directive version of wp_head(). Outputs the head section of a WordPress theme.

```APIDOC
## @wphead

### Description
Directive version of wp_head().

### Usage
```php
@wphead
```
```

--------------------------------

### @thumbnail - Echo featured image URL without markup

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Pass false as the last parameter to echo only the image URL instead of the full img markup.

```php
<img src="@thumbnail(false)" alt="My Image" />
<img src="@thumbnail(1, false)" alt="Post 1" />
<img src="@thumbnail(get_post(1), false)" alt="Post 1" />
<img src="@thumbnail('full', false)" alt="Full Image" />
<img src="@thumbnail(1, 'full', false)" alt="Post 1's Full Image" />
<img src="@thumbnail(get_post(1), 'full', false)" alt="Post 1's Full Image" />
```

--------------------------------

### @layouts with post ID

Source: https://github.com/log1x/sage-directives/wiki/Advanced-Custom-Fields

Retrieves layouts for a specific post by passing the post ID as the second parameter.

```php
@layouts('components', 1)
  [...]
@endlayouts
```

--------------------------------

### @category

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Echoes the first category of the current post. Can output as a link and target a specific post.

```APIDOC
## @category

### Description
Echoes the first category of the current post, optionally as a link, and optionally for a specific post.

### Usage
```php
@category
@category(true)
@category(1)
@category(1, true)
```

### Parameters
- **post** (int) - Optional - Post ID to get category from.
- **link** (bool) - Optional - Whether to output the category as a link (default false).

### Example
```php
@category(true)
```
```

--------------------------------

### @terms directive: echo comma-separated taxonomy terms

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Echoes a comma-separated list of taxonomy terms for the current post. Pass the taxonomy name as the first parameter.

```php
@terms('genre')
```

--------------------------------

### @title

Source: https://github.com/log1x/sage-directives/wiki/WordPress

Echoes the current post's title using get_the_title(). Can accept a specific post ID as a parameter.

```APIDOC
## @title

### Description
Echoes the current post's title using get_the_title(). Can accept a specific post ID as a parameter.

### Parameters
#### Optional Parameters
- **$post_id** (int) - Optional - The post ID to echo the title for.

### Examples
```php
@title
```

```php
@title(1)
```
```

--------------------------------

### @layout conditional with @layouts

Source: https://github.com/log1x/sage-directives/wiki/Advanced-Custom-Fields

Combines @layouts and @layout to conditionally render flexible content components based on get_row_layout(). Each @layout block checks for a specific layout name and uses @hassub/@sub to output subfields. Must be closed with @endlayout and @endlayouts.

```php
@layouts('components')
  @layout('card')
    <div class="card">
      @hassub('image')
        <div class="card-image">
          <img src="@sub('image', 'url')" alt="@sub('image', 'alt')" />
        </div>
      @endsub

      <div class="card-content">
        <h2>@sub('title')</h2>
        @sub('description')
      </div>
    </div>
  @endlayout

  @layout('button')
    @hassub('url')
      <a href="@sub('url')" class="button button--@sub('color') button--@sub('size')">
        @hassub('icon')
          <i class="fa fa-@sub('icon')"></i>
        @endsub
        <span>@sub('label')</span>
      </a>
    @endsub
  @endlayout

  @layout('content')
    @hassub('content')
      <div class="content">
        @sub('content')
      </div>
    @endsub
  @endlayout
@endlayouts
```

--------------------------------

### @sub with multiple array keys

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/acf.md

Passes multiple keys ('sizes', 'thumbnail') to access nested array values in a sub field.

```php
<ul class="slider">
  @fields('slides')
    <li class="slide">
      <img src="@sub('image', 'sizes', 'thumbnail')" alt="@sub('image', 'alt')" />
    </li>
  @endfields
</ul>
```

--------------------------------

### @title echo current post title

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Echoes the current post's title using get_the_title().

```php
@title
```

--------------------------------

### @user

Source: https://github.com/log1x/sage-directives/wiki/WordPress

A simple is_user_logged_in() conditional to display content only when a user is logged in. Can be closed with @enduser.

```APIDOC
## @user

### Description
A simple is_user_logged_in() conditional to display content only when a user is logged in.

### Closing Directive
- **@enduser** - Closes the conditional.

### Example
```php
@user
  You are logged in!
@enduser
```
```

--------------------------------

### @set directive

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/helpers.md

Sets the specified variable to a specified value.

```php
@set($hello, 'world')
```

--------------------------------

### @content echo current post content

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Echoes the current post's content using the_content().

```php
@content
```

--------------------------------

### @user

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Displays content only when a user is logged in. Can be closed with @enduser.

```APIDOC
## @user

### Description
Displays content only when a user is logged in. Can be closed with @enduser.

### Usage
```php
@user
  You are logged in!
@enduser
```
```

--------------------------------

### @categories - Echo comma separated list of current post's categories

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Echoes a comma separated list of the current post's categories.

```php
@categories
```

--------------------------------

### @title with post ID parameter

Source: https://github.com/log1x/sage-directives/wiki/WordPress

Echoes the title of a specific post by passing the post ID as a parameter.

```php
@title(1)
```

--------------------------------

### @layouts

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/acf.md

A helper directive for handling flexible content fields. It is essentially the same as @fields but provided for cleaner code in conjunction with @layout. It can be closed using @endlayouts.

```APIDOC
## @layouts

### Description
A helper directive for handling flexible content fields. It is essentially the same as @fields but provided for cleaner code in conjunction with @layout. It can be closed using @endlayouts.

### Usage
```php
@layouts('components')
  [...]
@endlayouts
```

### Parameters
- **field** (string) - Required - The flexible content field name.
- **postId** (int) - Optional - The post ID to retrieve layouts for.

### Example with post ID
```php
@layouts('components', 1)
  [...]
@endlayouts
```
```

--------------------------------

### @thumbnail - Echo current post featured image

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Echoes the current post's featured image using get_the_post_thumbnail with default size 'thumbnail'.

```php
@thumbnail
```

--------------------------------

### @thumbnail - Echo featured image for specific post

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Pass a post ID or WP_Post instance as the first parameter to echo the featured image of that post.

```php
@thumbnail(1)
@thumbnail(get_post(1))
```

--------------------------------

### @isfalse conditional with closing directive

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/helpers.md

Displays the enclosed output when the parameter exists but returns false. Close with @endisfalse.

```php
@isfalse($variable)
  Goodbye World
@endisfalse
```

--------------------------------

### @repeat

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/helpers.md

Repeats its contents a specified number of times. Can be closed using @endrepeat. Provides a $loop variable similar to Laravel's native looping.

```APIDOC
## @repeat

### Description
Repeats its contents a specified number of times. Can be closed using @endrepeat. Provides a $loop variable similar to Laravel's native looping.

### Usage
```php
<ul>
  @repeat(5)
    <li>{{ $loop->iteration }}</li>
  @endrepeat
</ul>
```

### Parameters
- **count** (int) - Required - The number of times to repeat the contents.

### Loop Variable
Inside the loop, a `$loop` variable is available with the following properties:
- `$loop->iteration` - The current iteration number (1-based).
- `$loop->index` - The current iteration index (0-based).
- `$loop->count` - The total number of iterations.
- `$loop->remaining` - The number of iterations remaining.
- `$loop->first` - Boolean indicating if this is the first iteration.
- `$loop->last` - Boolean indicating if this is the last iteration.

### Closing Tag
Use `@endrepeat` to close the block.
```

--------------------------------

### @instanceof conditional with @endinstanceof

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/helpers.md

Checks if the first parameter is an instance of the second parameter. Close with @endinstanceof.

```php
@instanceof($post, 'WP_Post')
  The post ID is {{ $post->ID }}.
@endinstanceof
```

--------------------------------

### @term directive: specify post ID and link output

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Accepts optional parameters: a post ID and a boolean to output terms as links. The taxonomy name remains the first parameter.

```php
@term('genre', 1)
@term('genre', 1, true)
@term('genre', true)
```

--------------------------------

### @hasoption conditional for theme options

Source: https://github.com/log1x/sage-directives/wiki/Advanced-Custom-Fields

Checks if a theme option field exists and is not empty. Can be closed with @endoption.

```php
@hasoption('facebook_url')
  Find us on <a href="@option('facebook_url')" target="_blank">Facebook</a>
@endoption
```

--------------------------------

### Conditional content for guests with @guest

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Displays content only when a user is not logged in, using ! is_user_logged_in(). Close with @endguest.

```php
@guest
  You must be <a href="/wp-login.php">logged in</a> to view this content.
@endguest
```

--------------------------------

### @thumbnail

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/wordpress.md

Echoes the current post's featured image using WordPress's get_the_post_thumbnail(). Supports optional post ID/WP_Post, size, and URL-only output.

```APIDOC
## @thumbnail

### Description
Echoes the current post's featured image using WordPress's `get_the_post_thumbnail()`. By default, it passes `thumbnail` as the size. Supports optional post ID/WP_Post, size, and URL-only output.

### Usage
```php
@thumbnail
@thumbnail(1)
@thumbnail(get_post(1))
@thumbnail('full')
@thumbnail(1, 'full')
@thumbnail(get_post(1), 'full')
<img src="@thumbnail(false)" alt="My Image" />
<img src="@thumbnail(1, false)" alt="Post 1" />
<img src="@thumbnail(get_post(1), false)" alt="Post 1" />
<img src="@thumbnail('full', false)" alt="Full Image" />
<img src="@thumbnail(1, 'full', false)" alt="Post 1's Full Image" />
<img src="@thumbnail(get_post(1), 'full', false)" alt="Post 1's Full Image" />
```

### Parameters
- **post** (int|WP_Post) - Optional - Post ID or WP_Post instance to get the featured image for. Defaults to the current post.
- **size** (string) - Optional - Image size to use. Defaults to `thumbnail`. Can be passed as the first parameter when no post is specified.
- **url** (bool) - Optional - When `false`, outputs only the image URL instead of the full `<img>` markup.
```

--------------------------------

### @isnotnull conditional with closing directive

Source: https://github.com/log1x/sage-directives/blob/master/docs/usage/helpers.md

Displays the enclosed output when the parameter exists and is not null. Close with @endisnotnull.

```php
@isnotnull($variable)
  There is something here.
@endisnotnull
```
Tokens:
Raw