You appear to be a bot. Output may be restricted

Description

Return SVG markup.

Usage

$string = twentyseventeen_get_svg( $args );

Parameters

$args

( array ) optional – { Parameters needed to display an SVG.

$icon

( string ) optional – Required SVG icon filename.

$title

( string ) optional – Optional SVG title.

$desc

( string ) optional – Optional SVG description. }

Returns

string SVG markup.

Source

File name: twentyseventeen/inc/icon-functions.php
Lines:

function twentyseventeen_get_svg( $args = array() ) {
  // Make sure $args are an array.
  if ( empty( $args ) ) {
    return __( 'Please define default parameters in the form of an array.', 'twentyseventeen' );
  }

  // Define an icon.
  if ( false === array_key_exists( 'icon', $args ) ) {
    return __( 'Please define an SVG icon filename.', 'twentyseventeen' );
  }

  // Set defaults.
  $defaults = array(
    'icon'     => '',
    'title'    => '',
    'desc'     => '',
    'fallback' => false,
  );

  // Parse args.
  $args = wp_parse_args( $args, $defaults );

  // Set aria hidden.
  $aria_hidden = ' aria-hidden="true"';

  // Set ARIA.
  $aria_labelledby = '';

  /*
	 * Twenty Seventeen doesn't use the SVG title or description attributes; non-decorative icons are described with .screen-reader-text.
	 *
	 * However, child themes can use the title and description to add information to non-decorative SVG icons to improve accessibility.
	 *
	 * Example 1 with title: <?php echo twentyseventeen_get_svg( array( 'icon' => 'arrow-right', 'title' => __( 'This is the title', 'textdomain' ) ) ); ?>
	 *
	 * Example 2 with title and description: <?php echo twentyseventeen_get_svg( array( 'icon' => 'arrow-right', 'title' => __( 'This is the title', 'textdomain' ), 'desc' => __( 'This is the description', 'textdomain' ) ) ); ?>
	 *
	 * See https://www.paciellogroup.com/blog/2013/12/using-aria-enhance-svg-accessibility/.
	 */
  if ( $args['title'] ) {
    $aria_hidden     = '';
    $unique_id       = twentyseventeen_unique_id();
    $aria_labelledby = ' aria-labelledby="title-' . $unique_id . '"';

    if ( $args['desc'] ) {
      $aria_labelledby = ' aria-labelledby="title-' . $unique_id . ' desc-' . $unique_id . '"';
    }
  }

  // Begin SVG markup.
  $svg = '<svg class="icon icon-' . esc_attr( $args['icon'] ) . '"' . $aria_hidden . $aria_labelledby . ' role="img">';

  // Display the title.
  if ( $args['title'] ) {
    $svg .= '<title id="title-' . $unique_id . '">' . esc_html( $args['title'] ) . '</title>';

    // Display the desc only if the title is already set.
    if ( $args['desc'] ) {
      $svg .= '<desc id="desc-' . $unique_id . '">' . esc_html( $args['desc'] ) . '</desc>';
    }
  }

  /*
	 * Display the icon.
	 *
	 * The whitespace around `<use>` is intentional - it is a work around to a keyboard navigation bug in Safari 10.
	 *
	 * See https://core.trac.wordpress.org/ticket/38387.
	 */
  $svg .= ' <use href="#icon-' . esc_html( $args['icon'] ) . '" xlink:href="#icon-' . esc_html( $args['icon'] ) . '"></use> ';

  // Add some markup to use as a fallback for browsers that do not support SVGs.
  if ( $args['fallback'] ) {
    $svg .= '<span class="svg-fallback icon-' . esc_attr( $args['icon'] ) . '"></span>';
  }

  $svg .= '</svg>';

  return $svg;
}
 

 View on GitHub View on Trac