add_shortcode() – Adds a new shortcode.

You appear to be a bot. Output may be restricted

Description

Adds a new shortcode.

Care should be taken through prefixing or other means to ensure that the shortcode tag being added is unique and will not conflict with other, already-added shortcode tags. In the event of a duplicated tag, the tag loaded last will take precedence.

Usage

add_shortcode( $tag, $callback );

Parameters

$tag
( string ) required – Shortcode tag to be searched in post content.
$callback
( callable ) required – The callback function to run when the shortcode is found. Every shortcode callback is passed three parameters by default, including an array of attributes (`$atts`), the shortcode content or null if not set (`$content`), and finally the shortcode tag itself (`$shortcode_tag`), in that order.

Returns

void

Source

File name: wordpress/wp-includes/shortcodes.php


Lines:

1 to 29 of 29
function add_shortcode( $tag, $callback ) {
  global $shortcode_tags;

  if ( '' === trim( $tag ) ) {
    _doing_it_wrong(
      add_shortcode,
      __( 'Invalid shortcode name: Empty name given.' ),
      '4.4.0'
    );
    return;
  }

  if ( 0 !== preg_match( '@[<>&/\[\]\x00-\x20=]@', $tag ) ) {
    _doing_it_wrong(
      add_shortcode,
      sprintf(
        /* translators: 1: Shortcode name, 2: Space-separated list of reserved characters. */
        __( 'Invalid shortcode name: %1$s. Do not use spaces or reserved characters: %2$s' ),
        $tag,
        '& / < > [ ] ='
      ),
      '4.4.0'
    );
    return;
  }

  $shortcode_tags[ $tag ] = $callback;
}
 

 View on GitHub View on Trac