bw_code_example_link() – Create a nicely formatted link to the definition of the shortcode

Description

Create a nicely formatted link to the definition of the shortcode

When the shortcode= parameter is not specified then we assume that this is an example that we want to both show AND make a link to the help in oik-plugins. The first word is expected to be the shortcode and the rest are parameters e.g. [bw_code bw_code shortcode=bw_code]

Usage

bw_code_example_link( $atts );

Parameters

$atts

( mixed ) required –

Returns

void

Source

File name: oik/shortcodes/oik-codes.php
Lines:

function bw_code_example_link( $atts ) {
  $shortcode_string = bw_array_get( $atts, 0, null );
  $link_text = "<span>&#91;</span>";
  $link_text .= $shortcode_string; 
  $link_text .= "]";
  $shortcodes = explode( " ", $shortcode_string );
  $shortcode = $shortcodes[0];
  $callback =  bw_get_shortcode_callback( $shortcode );
  if ( $callback ) {
    $function = bw_get_shortcode_function( $shortcode, $callback );
  } else {
    $function = null;
  }
  if ( $function ) {
  $link = oik_get_shortcodes_server( );
    $link .= "/oik-shortcodes/$shortcode/$function";
  $link = apply_filters( "bw_sc_link", $link, $shortcode, $function );
  /* translators: %s: shortcode name */
    BW_::alink( "bw_code $shortcode", $link, $link_text, sprintf( __( 'Link to help for shortcode: %1$s', "oik" ), $shortcode ) );   
  } else { 
    span( "bw_code $shortcode" );
    e( $link_text );
    epan();
  }   
}
 

 View on GitHub View on Trac