jamesdlow

<p>Plugin Docs adds an additional text box to the plugins screen so that you enter notes to document what each plugin is doing, what it depends on, and what depends on it.</p>


Plugin Docs

Add notes to your plugins so you can document why you needed each one

kentfarst

<p>WP Theater provides shortcodes for integrating <strong>YouTube</strong> and <strong>Vimeo</strong> video embeds and feeds into your posts or widgets. Some options include traditional embedding, single video previews, a wrapped “Theater” embed, and video listings from playlists, channels, albums and groups.  WP Theater was built with developers in mind, those who need flexibility. With that said, great effort was put into making sure this plugin stayed simple.</p>
<h4>Requirements</h4>
<ol>
<li>Current version tested on WordPress version 3.9 and later.</li>
<li>PHP 5.3 or later with cURL</li>
</ol>
<h4>Usage</h4>
<p>For parameters and their usage please visit:</p>
<p>http://redshiftstudio.com/wp-theater/</p>
<p><strong>Boring Embed</strong> – The classic</p>
<pre><code>

</code></pre>
<p><strong>Preview</strong> – Thumbnail and title of a single video</p>
<pre><code>

</code></pre>
<p><strong>Theater</strong> – Traditional embed that’s wrapped for styling, has optional Lower Lights and Full Window buttons, and is responsive.</p>
<pre><code>

</code></pre>
<p><em>The following contain a “theater” by default</em></p>
<p><strong>User</strong> – Listing of a user’s videos</p>
<pre><code>

// for YouTube's v3 API see FAQ about user uploads vs playlists.
</code></pre>
<p><strong>Channel</strong> – Listing of videos from a specific channel</p>
<pre><code>
</code></pre>
<p><strong>Playlist</strong> – Listing of videos from a user’s playlist</p>
<pre><code>
</code></pre>
<p><strong>Album</strong> – Listing of videos from a specific album</p>
<pre><code>
</code></pre>
<p><strong>Group</strong> – Listing of videos from a specific group</p>
<pre><code>
</code></pre>
<h3>Developer FAQ</h3>
<h4>How can I customize the output</h4>
<p>Filters exist that can handle complete customization of the output.  Written as “Filter_Hook” ($callback_params … )</p>
<p>Display — Override built in output</p>
<ul>
<li>“wp_theater-pre_video_shortcode” ( FALSE, $feed, $atts )</li>
<li>“wp_theater-pre_theater” ( FALSE, $atts, $content, $tag )</li>
<li>“wp_theater-pre_video_preview” ( FALSE, $video, $atts, $selected )</li>
</ul>
<p>Attributes</p>
<ul>
<li>“wp_theater-format_params” ( $atts, $content, $tag )</li>
</ul>
<p>API Feeds — Override built in api request and parsing.  NOTE: Keep in mind that these filters will only be called when the transient cache is updated.</p>
<ul>
<li>“wp_theater-pre_get_request_url” ( FALSE, $atts, $request, $output )</li>
<li>“wp_theater-parse_{$service}_response” ( $out, $response, $atts) // v1.1.3</li>
</ul>
<p>Content</p>
<ul>
<li>“wp_theater-section_title” ( $title )</li>
<li>“wp_theater-video_title” ( $title )</li>
<li>“wp_theater-{$service}_more_url” ( FALSE, $atts, $data ) // v1.1.4</li>
</ul>
<p>Presets</p>
<ul>
<li>“wp_theater-get_preset” ( $name )</li>
<li>“wp_theater-set_preset” ( $arr, $name )</li>
</ul>
<h4>How do I add my own preset?</h4>
<p>The following code will create a preset named “my_preset”.  We do not currently, but are planning to, offer a method of saving presets to the database so that they stick around between theme’s.</p>
<pre><code>function my_preset_init ($presets) {
    $presets->set_preset( 'my_preset', shortcode_atts( $presets->get_preset( 'youtube' ), array(
        'embed_width' => 342,
        'embed_height' => 192,
        'max' => 9,
    ) ) );
    add_shortcode( 'my_preset', array( WP_Theater::$shortcodes, 'video_shortcode' ) );
}
add_action('wp_theater-shortcodes_init', 'my_preset_init');
</code></pre>
<h4>What values can I define in presets</h4>
<p>Listed below are all of the possible settings you can define in a preset with their base values</p>
<pre><code>array(
    // general options
    'preset' => '',
    'service' => '',
    'mode' => 'embed',
    'id' => '',
    'embed_width' => FALSE,
    'embed_height' => FALSE,
    'class' => '',
    'cache' => FALSE,

    // preview & listing options
    'img_size' => 'medium',
    'columns' => 3,
    'max' => 12,
    'autoplay_onclick' => TRUE,

    // Title options
    'show_title' => TRUE,
    'show_video_title' => TRUE,
    'title' => '',

    // More link options
    'show_more_link' => TRUE,
    'more_url' => FALSE,
    'more_text' => FALSE,

    // Theater options
    'show_theater' => TRUE,
    'theater_id' => FALSE,
    'show_fullwindow' => FALSE,
    'show_lowerlights' => FALSE,
    'keep_ratio' => TRUE,
    'iframe_placeholder' = > TRUE            // since 1.2.0

    // can only be defined in presets
    'modes' => array(), // the modes array with matching link formats
    'classes' => array( // the classes to apply to their respective elements
        'section' => 'entry-section wp-theater-section %service%',
        'theater' => 'wp-theater-bigscreen',
        'embed' => 'wp-theater-iframe',
        'list' => 'wp-theater-listing',
        'preview' => 'video-preview'
    )
);
</code></pre>
<h4>How can I modify the embed url?</h4>
<p>Each preset requires a modes array to store the different link formats used.  You can directly access and modify these yourself through a theme’s functions.php.<br />
e.g.</p>
<pre><code>// make youtube embed with https and youtube-nocookie.com
function my_preset_init ($presets) {
    $youtube_preset = $presets->get_preset( 'youtube' );
    $youtube_preset['modes']['embed'] = 'https://www.youtube-nocookie.com/embed/%id%?wmode=transparent&autohide=1';
    $presets->set_preset( 'youtube', $youtube_preset );
}
add_action('wp_theater-shortcodes_init', 'my_preset_init');
</code></pre>
<p>NOTE:  Each mode URL must have %id% in the place of the id.  And, it’s a bit dumb but, for now you must include at least one query parameter in an embed’s url.</p>
<h4>What do the formatted feeds look like?</h4>
<p>Vimeo’s feed will return exactly what their API states except we merge their info and video requests into one and clone values to help normalize the feeds.  Youtube on the other hand is almost completely reformatted into a format based on Vimeo’s</p>
<p>You can count on the full feeds returning the following content with an exception being that single preview feeds do not have the feed title or url.</p>
<p>Also, with YouTube’s v3 API enabled, rating, likeCount and viewCount will always be empty strings since you must use OAuth2 and be a verified content owner:</p>
<pre><code>object
    'title' => string
    'url' => string
    'videos' => array
        0 => object
            'title' => string
            'id' => string
            'url' => string
            'upload_date' => string
            'description' => string
            'category' => string
            'duration' => string
            'rating' => string
            'likeCount' => string
            'viewCount' => string
            'width' => string
            'height' => string
            'thumbnails' => array
                'small' => string
                'medium' => string
                'large' => string
                'cover' => string       // since 1.2.0 -- set to the largest available image.
</code></pre>

WP Theater

Shortcodes for YouTube and Vimeo. Includes embeds, "Theater" embed, thumbed previews, playlist, channel, user uploads and groups.

Plugin Docs vs WP Theater