Mastering the shortcode api

Mastering the Shortcode API

Peter Baylies

Semper Fi Web Design

Monday, November 7, 11

What’s a shortcode

• It’s a tag that can dynamically insertcontent into your wordpress site.

It should look sort of like this:

[gallery]


How do I make them?

• with the add_shortcode() function

• arguments: your shortcode’s nameand your PHP function that it calls:

add_shortcode(‘tag’,‘my_function_name’);


Wait, my PHP function?

• Yes, it can be passed up to three arguments:

my_function_name($atts,$content,$code);

• arguments passed to your shortcode

• content contained within your shortcode

• the name of the shortcode itself


Attributes• Shortcode attributes look like this:

[gallery id=”123” columns=”4”]

• They get processed with shortcode_atts()

extract ( shortcode_atts ( array ( ‘id’ => null, ‘columns’=>3 ), $atts ) );

• This sets defaults and validates arguments.


Content

• Shortcodes can enclose content too.

[caption]This is a caption.[/caption]

The text in between the shortcode tags gets passed to $content for processing.


Code

• The name of the shortcode called.

• This gives you the ability to write one function to handle multiple shortcodes.

• This helps avoid duplication of code.


Removing a shortcode:

• remove_shortcode()

• Lets you unregister an existing shortcode

• This lets you replace other shortcodeswith your own custom code.


Running a shortcode:

•do_shortcode()

• This handles shortcode processing.

• Run it on $content to nest shortcodes:

[loop] [title] [content][/loop]


That’s It!

• Now go forth and write shortcodes!

• Any Questions?


Mastering the shortcode api

Technology

Transcript of Mastering the shortcode api