shortcode_atts( array $pairs, array $atts, string $shortcode = '' ): array

User Contributed Notes

1. Skip to note 6 content

   Aaron T. Grogg 5 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 13You must log in to vote on the helpfulness of this note

   It might be really useful to note that attribute names must be all lowercase…

   If your shortcode looks like this:
   [shortcode attOne="foo" attTwo="bar"]
   The array passed to the callback function will look like this:
   Array( attone => "foo", atttwo => "bar" )

   So, I guess you could use camelCase in the shortcode, just remember to expect those camelCase to be all lowercase in your shortcode_atts…

   • This is not true, but can seem true: see explanation.

     crstauf 5 years ago
   • To clear up any confusion: Aaron’s post is correct, while the the explanation by crstauf is technically correct. It is true that shortcode_atts() makes a case-sensitive comparison between the first argument (array of supported attributes and their defaults) and the second argument (array of user-defined attributes in shortcode tag). But the user-defined attributes are normalized to lowercase by WordPress before being passed to the shortcode callback function (see shortcode_parse_atts()). So the case-sensitivity of shortcode_atts() only becomes an issue if you define supported attributes using uppercase characters.

     Bart Kuijper 4 years ago
2. Skip to note 7 content

   Codex 9 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 6You must log in to vote on the helpfulness of this note

   Example

   /**
    * Callback to register a bartag shortcode.
    *
    * @param array $atts Shortcode attributes.
    * @return string Shortcode output.
   function wpdocs_bartag_func( $atts ) {
   	$atts = shortcode_atts(
   		array(
   			'foo' => 'no foo',
   			'bar' => 'default bar',
   		), $atts, 'bartag' );
   
   	return 'bartag: ' . esc_html( $atts['foo'] ) . ' ' . esc_html( $atts['bar'] );
   }
   add_shortcode( 'bartag', 'wpdocs_bartag_func' );

   [bartag foo=”koala” bar=”bears”] outputs the following:
   bartag: koala bears

   [bartag foo=”koala”] outputs the following:
   bartag: koala default bar

   This creates a “[bartag]” shortcode that supports two attributes: [bartag foo="something" bar="something else"]. Both attributes are optional and will take on default options if they are not provided.
3. Skip to note 8 content

   crstauf 5 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

   Clarification on Aaron’s note:

   The case of the keys on the $pairs must match the keys on the $atts, or the value will be discarded.

   See these examples:

   print_r( shortcode_atts( array(
   	'CAPITAL' => '1',
   	'fooBar' => '2',
   ), array(
   	'CAPITAL' => '3',
   	'fooBar' => '4',
   ) ) );
   // Output: Array ( [CAPITAL] => 3 [fooBar] => 4 )

   print_r( shortcode_atts( array(
   	'CAPITAL' => '1',
   	'fooBar' => '2',
   ), array(
   	'capital' => '3',
   	'fooBar' => '4',
   ) ) );
   // Output: Array ( [CAPITAL] => 1 [fooBar] => 4 )

   print_r( shortcode_atts( array(
   	'CAPITAL' => '1',
   	'fooBar' => '2',
   ), array(
   	'capital' => '3',
   	'foobar' => '4',
   ) ) );
   // Output: Array ( [CAPITAL] => 1 [fooBar] => 2 )

   print_r( shortcode_atts( array(
   	'capital' => '1',
   	'fooBar' => '2',
   ), array(
   	'capital' => '3',
   	'foobar' => '4',
   ) ) );
   // Output: Array ( [capital] => 3 [fooBar] => 2 )
4. Skip to note 9 content

   Tessa Watkins 3 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

   To ensure this function works and allow for case insensitive attributes, I use array_change_key_case in a one-liner like this

   /**
    * My Custom Shortcode
    * 
    * @param array $atts Optional. An associative array of key/value attributes. Default is empty array.
    * @param string $content Optional. The content between the opening and closing shortcode tags. Default is an empty string.
    * @param string $tag Optional. The name of the shortcode, provided for context to enable filtering. Default is an empty string.
    * 
    * @return string shortcode output
    */
   function tw_custom_shortcode($atts = array(), $content = '', $tag = '')
   {
       $atts = shortcode_atts(array(), array_change_key_case((array)$atts, CASE_LOWER), $tag);
   
       //Do stuff, probably sanitize inputs
   
       $output = '';
       return $output;
   }
   add_shortcode('tw_custom', 'tw_custom_shortcode');
5. Skip to note 10 content

   zitomerh 8 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note

   I had to hunt around to find all the pieces, I hope others find this helpful.

   So, building on a previous example:

   /**
    * How to use shortcode callback parms with shortcode_atts to make
    * callback code flexible and re-useable.
    *
    * This allows filters to be applied to a callback depending on which
    * shortcode called it.
    *
    * @param array  $atts    Shortcode attributes.
    * @param string $content Shortcode content.
    * @param string $tag     The shortcode which invoked the callback
    * @return string Shortcode output.
    */
   function my_callback_func( $atts, $content, $tag ) {
       $atts = shortcode_atts(
           array(
               'foo' => '',
               'bar' => '',
           ), $atts, $tag );
   
    //do something here(trivial example)
   	if ( !empty($zoo) ) {
   		return $zoo;  //where did $zoo come from? see below
   	}
   	else return $foo;
       
   }
   
   add_shortcode( 'myshortcode1', 'my_callback_func' );
   add_shortcode( 'myshortcode2', 'my_callback_func' );
   
   /* now make a filter that's applied ONLY when my_callback_func is invoked by myshortcode1 -
   this example adds param 'zoo' to myshortcode1  */
   
   add_filter ('shortcode_atts_myshortcode1', 'add_zoo', 10, 3);
   function add_zoo ($out, $pairs, $atts ) {
   	$out['zoo'] = '';
   	return $out;
   }
   // Now we can use [myshortcode1 foo='myfoo' zoo='myzoo']  output: myzoo
   // and [myshortcode2 foo='myfoo' zoo='myzoo']  output: myfoo

   • The example function `my_callback_func` gets the attributes into an array, but uses the individual attribute names as variables. No `extract` was done. Also, the filter `add_zoo` only sets it to ”, not the value the user entered.

     Joy 5 years ago