a little bit of documentation

This commit is contained in:
John Bintz 2009-09-23 21:58:02 -04:00
parent 03e3d4694c
commit c34b93a030
1 changed files with 56 additions and 20 deletions

View File

@ -77,6 +77,9 @@ class WhatDidTheySayAdmin {
}
}
/**
* Filter for WP_Query#get_posts to add searching for transcripts.
*/
function posts_where($where) {
global $wpdb;
@ -95,6 +98,9 @@ class WhatDidTheySayAdmin {
return $where;
}
/**
* Filter for WP_Query#get_posts to add searching for transcripts.
*/
function posts_join($join) {
global $wpdb;
@ -106,6 +112,9 @@ class WhatDidTheySayAdmin {
return $join;
}
/**
* Action for when a non-admin page is displayed.
*/
function template_redirect() {
wp_enqueue_script('toggle-transcript', plugin_dir_url(dirname(__FILE__)) . 'js/toggle-transcript.js', array('prototype'), false, true);
if (current_user_can('submit_transcriptions')) { wp_enqueue_script('scriptaculous-effects'); }
@ -127,46 +136,61 @@ class WhatDidTheySayAdmin {
}
}
/**
* Dialog short code.
*/
function shortcode_dialog($atts, $speech) {
extract(shortcode_atts(array(
'name' => 'Nobody',
'direction' => ''
), $atts));
list($content) = apply_filters('filter_shortcode_dialog', "", $name, $direction, $speech);
return $content;
return end(apply_filters('filter_shortcode_dialog', $name, $direction, $speech, ""));
}
function filter_shortcode_dialog($content, $name, $direction, $speech) {
/**
* Filter for dialog short code.
*/
function filter_shortcode_dialog($name, $direction, $speech, $content) {
$content = '<div class="dialog"><span class="name">' . $name . '</span>';
if (!empty($direction)) {
$content .= ' <span class="direction">' . $direction . '</span>';
}
$content .= ' <span class="speech">' . $speech . '</span></div>';
return array($content, $name, $direction, $speech);
return array($name, $direction, $speech, $content);
}
/**
* Scene action short code.
*/
function shortcode_scene_action($atts, $description) {
extract(shortcode_atts(array(), $atts));
list($content) = apply_filters('filter_shortcode_scene_action', "", $description);
return $content;
return end(apply_filters('filter_shortcode_scene_action', $description, ""));
}
function filter_shortcode_scene_action($content, $description) {
return array('<div class="scene-action">' . $description . '</div>', $description);
/**
* Filter for scene action short code.
*/
function filter_shortcode_scene_action($description, $content) {
return array($description, '<div class="scene-action">' . $description . '</div>', );
}
/**
* Scene heading short code.
*/
function shortcode_scene_heading($atts, $description) {
extract(shortcode_atts(array(), $atts));
list($content) = apply_filters('filter_shortcode_scene_heading', "", $description);
return $content;
return end(apply_filters('filter_shortcode_scene_heading', $description, ""));
}
function filter_shortcode_scene_heading($content, $description) {
return array('<div class="scene-heading">' . $description . '</div>', $description);
/**
* Filter for scene heading short code.
*/
function filter_shortcode_scene_heading($description, $content) {
return array($description, '<div class="scene-heading">' . $description . '</div>');
}
/**
@ -187,6 +211,9 @@ class WhatDidTheySayAdmin {
return array($language, '<h3 class="transcript-language">' . $language . '</h3>');
}
/**
* Handle the_matching_transcript_excerpts.
*/
function the_matching_transcript_excerpts($transcripts, $search_string = '', $output = "") {
ob_start();
if (!empty($search_string)) {
@ -342,6 +369,9 @@ class WhatDidTheySayAdmin {
return $updated;
}
/**
* Handle transcript approval.
*/
function handle_update_approve_transcript($info) {
$this->is_ajax = true;
@ -359,6 +389,9 @@ class WhatDidTheySayAdmin {
header('HTTP/1.1 401 Unauthorized');
}
/**
* Handle transcript deletion.
*/
function handle_update_delete_transcript($info) {
$this->is_ajax = true;
@ -374,6 +407,9 @@ class WhatDidTheySayAdmin {
header('HTTP/1.1 401 Unauthorized');
}
/**
* Handle updating default styles.
*/
function handle_update_styles($info) {
$updated = false;
if (current_user_can('edit_themes')) {