Description

Echo a structural wrap div.

A check is made to see if the $context is in the genesis-structural-wraps theme support data. If so, then the $output may be echoed or returned.

Usage

$null|string = genesis_structural_wrap( $context, $output, $deprecated );

Parameters

$context

( string ) optional – The location ID.

$output

( string ) optional default: open – Optional. The markup to include. Can also be 'open' (default) or 'close' to use pre-determined markup for consistency.

$deprecated

( bool ) optional – Deprecated.

Returns

null|string Wrap HTML, or null if genesis-structural-wraps support is falsy.

Source

File name: genesis/lib/functions/layout.php
Lines:

function genesis_structural_wrap( $context = '', $output = 'open', $deprecated = null ) {

  if ( null !== $deprecated ) {
    $message = __( 'The default is true, so remove the third argument.', 'genesis' );

    if ( false === (bool) $deprecated ) {
      $message = __( 'Use `genesis_get_structural_wrap()` instead.', 'genesis' );
    }

    _deprecated_argument( __FUNCTION__, '2.7.0', esc_html( $message ) );
  }

  $output = genesis_get_structural_wrap( $context, $output );

  // Apply original default value.
  $deprecated = null === $deprecated ? true : $deprecated;

  if ( false === (bool) $deprecated ) { // Kept for backwards compatibility.
    return $output;
  }

  // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
  echo $output;

}