add_cap( 'publish_announcements' );
$role->add_cap( 'create_announcements' );
$role->add_cap( 'delete_announcements' );
$role->add_cap( 'delete_published_announcements' );
$role->add_cap( 'edit_announcements' );
$role->add_cap( 'edit_published_announcements' );
}
flush_rewrite_rules();
}
register_deactivation_hook( WP_PLUGIN_DIR . '/announcements-ticker/announcements-ticker.php', 'flh_announcements_deactivate' );
/* Remove custom capabilities when plugin is deactivated
*
*/
function flh_announcements_deactivate() {
/* Get the administrator role. */
$role =& get_role( 'administrator' );
/* If the administrator role exists, add required capabilities for the plugin. */
if ( !empty( $role ) ) {
/* CPT management capabilities. */
$role->remove_cap( 'publish_announcements' );
$role->remove_cap( 'create_announcements' );
$role->remove_cap( 'delete_announcements' );
$role->remove_cap( 'delete_published_announcements' );
$role->remove_cap( 'edit_announcements' );
$role->remove_cap( 'edit_published_announcements' );
}
flush_rewrite_rules();
}
add_action( 'init', 'flh_add_announcement_cpt' );
/* Register the custom post type for Announcement
*
*/
function flh_add_announcement_cpt() {
/* Set up the arguments for the 'Announcement' post type. */
$announcement_args = array(
'labels'=>array(
'name'=>__('Announcements'),
'singular_name'=>__('Announcement'),
'add_new'=>__('Add New'),
'add_new_item'=>__('Add New Announcement'),
'edit'=>__('Edit'),
'edit_item'=>__('Edit Announcement'),
'new_item'=>__('New Announcement'),
'view_item'=>__('View Announcement'),
'search_items'=>__('Search Announcements'),
'not_found'=>__('No announcements found'),
'not_found_in_trash'=>__('No announcements found in trash')),
'description'=>__('A short announcement you want to put on your site with different styling'),
'public' => true,
'menu_position' => 9,
'has_archive' => false,
'capability_type' => 'announcement',
'map_meta_cap' => true,
'rewrite' => false
);
/* Register the announcement post type. */
register_post_type( 'announcement', $announcement_args );
}
//use the shortcode [announcements] in page or post content to display the announcements
add_shortcode( 'announcements', 'flh_announcements_handler' );
//shortcode handler which queries for the announcements and displays them
function flh_announcements_handler() {
$output = '';
//get announcement CPT of those in the future
//it's not enough to just get post_status=future as missed schedule posts will also show up
add_filter( 'posts_where', 'flh_announcements_filter_where' );
$announce_query = new WP_Query( array( 'post_type' => 'announcement',
//'post_status' => 'future',
'orderby' => 'date',
'order' => 'ASC'
) );
remove_filter( 'posts_where', 'flh_announcements_filter_where' );
// don't output anything if there are no posts
if ( $announce_query->have_posts() ) {
$output .= '
';
//cannot use the_content() directly as that echoes immediately, so the output is in the wrong place
//get unfiltered content instead. have to filter and make it safe before display
//code from http://codex.wordpress.org/Function_Reference/the_content
//$content = get_the_content();
//$content = apply_filters( 'the_content', $content );
//$content = str_replace( ']]>', ']]>', $content );
//going to use my custom excerpt function instead
$content = flh_announcements_excerpt_max_charlength( get_the_excerpt(), get_permalink(), $max_chars );
$output .= $content;
$output .= '
';
endwhile;
wp_reset_postdata();
$output .= '
';
return $output;
}
/* Output an excerpt with a maximum of $charlength characters (plus a bit more because of the [Read All] )
*
* code is adapted from http://codex.wordpress.org/Function_Reference/get_the_excerpt
*
* @param $text string with the text to be shortened
* @param $permalink link to use for the [Read All] link if $text is longer than $charlength
* @param $charlength int for maximum number of characters before the ending will be replaced with [Read All]
*
* @returns $text if it was less than $charlength, else a shortened text with [Read All] as the hyperlink text
*/
function flh_announcements_excerpt_max_charlength( $text, $permalink, $charlength ) {
$excerpt = $text;
$charlength++;
if( mb_strlen( $excerpt ) > $charlength ) {
//the -5 seems to be to make up for the [...] at the end
//use -10 here because the [Read All] bit is longer, it's actually not quite enough
$subex = mb_substr( $excerpt, 0, $charlength - 10 );
$exwords = explode(' ', $subex );
//figure out how long the last (possibly) partial word is
$excut = - ( mb_strlen( $exwords[ count( $exwords ) - 1 ] ) );
if( $excut < 0 ) {
//remove the last (partial) word
$excerpt = mb_substr( $subex, 0, $excut );
}
else
$excerpt = $subex;
$excerpt .= '… [Read All]';
}
return $excerpt;
}
//filter function for WP_Query used in shortcode handler
function flh_announcements_filter_where( $where = '' ) {
//refers to future posts
$where .= " AND post_date >= '" . date( 'Y-m-d H:i:s' ) . "'";
return $where;
}
//add filter to change post_status for announcement post type
add_filter( 'wp_insert_post_data', 'flh_announcements_insert_post_data', 10, 2 );
//filter function to change post_status from 'future' to 'publish'
//this allows the Read All link to work without throwing a 404
function flh_announcements_insert_post_data( $data, $postarr ) {
//if this is a scheduled announcement
if( $data[ 'post_type' ] == 'announcement' && $data[ 'post_status' ] == 'future' ) {
$data[ 'post_status' ] = 'publish';
}
return $data;
}
//enqueue scripts and styles for news ticker
add_action( 'wp_enqueue_scripts', 'flh_announcements_ticker_enqueue' );
function flh_announcements_ticker_enqueue() {
wp_enqueue_script(
'news-ticker',
plugins_url( 'announcements-ticker/js/jquery.ticker.js' ), //passing __FILE__ as the 2nd param doesn't work for symlinks
array( 'jquery' )
);
wp_enqueue_script(
'start-news-ticker',
plugins_url( 'announcements-ticker/js/ticker-init.js' ),
array( 'news-ticker' )
);
wp_enqueue_style(
'news-ticker-style',
plugins_url( 'announcements-ticker/css/ticker-style.css' )
);
}
//enqueue js scripts and styles only for my own options page so it doesn't screw up other settings pages
add_action( 'admin_print_styles-settings_page_announcements_options', 'flh_announcements_admin_enqueue' );
function flh_announcements_admin_enqueue() {
//this changes the colour in the colour samples when the text changes
//also makes the sliders and all the other dynamic stuff work
wp_enqueue_script(
'flh-announcements-options',
plugins_url( 'announcements-ticker/js/announcements-options.js' ),
array( 'wp-color-picker' )
);
// this is for the colour samples and slider text
wp_enqueue_style(
'flh-announcements-options-style',
plugins_url( 'announcements-ticker/css/announcements-options.css' ),
false
);
//need this to display the colour picker
wp_enqueue_style( 'wp-color-picker' );
//to display the sample ticker
wp_enqueue_style(
'news-ticker-style',
plugins_url( 'announcements-ticker/css/ticker-style.css' )
);
}
//add submenu to Settings menu
add_action( 'admin_menu', 'flh_announcements_create_menu' );
//Add an entry to the Settings menu named 'Announcements'
function flh_announcements_create_menu() {
add_options_page( 'Announcements Options', 'Announcements', 'manage_options', 'announcements_options', 'flh_announcements_settings_render_page' );
}
/* Render the settings page.
*/
function flh_announcements_settings_render_page() {
$lorem_ipsum = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer tristique gravida eleifend. Nam sit amet est nunc. Nam id purus felis, quis gravida ipsum. Integer eu lectus tellus, non consequat risus. Duis ultrices nibh non neque mattis tincidunt. Suspendisse potenti. Phasellus ac nulla sit amet turpis condimentum rutrum nec a est. Morbi dictum urna nec orci suscipit ornare. Etiam ut nisi arcu, vitae semper urna. Donec fermentum ornare ipsum, ut suscipit nisl suscipit ac.';
$options = flh_announcements_get_options();
?>
Announcements Options
'#21759b',
'text-color' => '#ffffff',
'ticker-height' => '58px',
'max-chars' => 140,
'text-size' => '16px'
);
return apply_filters( 'flh_announcements_default_options', $defaults );
}
/* Get options from the database and merge with defaults
*/
function flh_announcements_get_options() {
$defaults = flh_announcements_get_default_options();
$options = get_option( 'flh_announcements_options', $defaults );
$options = wp_parse_args( $options, $defaults );
return $options;
}
/* The following 4 functions define min and max values for ticker height and text size.
* Extra functions are needed so the validation function can access these values as well.
*
* Because Firefox doesn't support sliders and replaces them with textboxes, the validation function
* has to check that the input is within range.
*
*/
function flh_announcements_get_min_ticker_height() {
return apply_filters( 'flh_announcements_min_ticker_height', 32 );
}
function flh_announcements_get_max_ticker_height() {
return apply_filters( 'flh_announcements_max_ticker_height', 400 );
}
function flh_announcements_get_min_text_size() {
return apply_filters( 'flh_announcements_min_text_size', 8 );
}
function flh_announcements_get_max_text_size() {
return apply_filters( 'flh_announcements_max_text_size', 32 );
}
/* Use the WordPress Settings API to set up the Settings sections and fields
*/
add_action( 'admin_init', 'flh_announcements_options_init' );
function flh_announcements_options_init() {
register_setting(
'flh_announcements_options',
'flh_announcements_options',
'flh_announcements_validate_options'
);
add_settings_section(
'ticker-appearance', // the 'id' attribute of tags
'Ticker Appearance', // section title
'flh_announcements_appearance_section', //function callback for section content
'announcements_options' //menu page to display section
);
add_settings_section(
'ticker-behavior-section',
'Ticker Behavior',
'flh_announcements_behavior_section',
'announcements_options'
);
// Ticker Appearance Settings
add_settings_field( 'ticker-color', 'Ticker Color', 'flh_announcements_options_field_ticker_color', 'announcements_options', 'ticker-appearance' );
add_settings_field( 'text-color', 'Text Color', 'flh_announcements_options_field_text_color', 'announcements_options', 'ticker-appearance' );
add_settings_field( 'text-size', 'Text Size', 'flh_announcements_options_field_text_size', 'announcements_options', 'ticker-appearance' );
add_settings_field( 'ticker-height', 'Ticker Height (px)', 'flh_announcements_options_field_ticker_height', 'announcements_options', 'ticker-appearance' );
// Ticker Behavior Settings
add_settings_field( 'max-chars', 'Maximum number of characters', 'flh_announcements_options_field_max_chars', 'announcements_options', 'ticker-behavior-section' );
}
/* Callback for Ticker Appearance section
*/
function flh_announcements_appearance_section() {
?>
Control what your ticker will look like. Changes here can be immediately previewed in the sample ticker.
Save the changes to see them take effect on your site.
Control elements of the ticker's behavior here. Save the changes to see them take effect.
= flh_announcements_get_min_text_size() &&
$input['text-size'] <= flh_announcements_get_max_text_size() ) {
$output['text-size'] = $input['text-size'] . 'px';
}
}
}
// ticker height must in in px. if just a number is given, add px to it
if ( isset( $input['ticker-height'] ) ) {
if ( preg_match( '/^[0-9]+$/', $input['ticker-height'] ) ) { //just a number, append px to it
// check that input is within range
if ( $input['ticker-height'] >= flh_announcements_get_min_ticker_height() &&
$input['ticker-height'] <= flh_announcements_get_max_ticker_height() ) {
$output['ticker-height'] = $input['ticker-height'] . 'px';
}
}
}
// max chars must be a decimal number
if( isset( $input['max-chars'] ) ) {
if ( preg_match( '/^[0-9]+$/', $input['max-chars'] ) ) //numbers
$output['max-chars'] = $input['max-chars'];
}
return $output;
}
/* ==================================================================================================== */
/* Callback functions to display the individual settings initialized by add_settings_field() */
/* ==================================================================================================== */
/* Callback function to display colour picker for the ticker background
*
* Code used to be adapted from twentyeleven theme's link colour picker, until WP 3.5's colour picker came out
* http://make.wordpress.org/core/2012/11/30/new-color-picker-in-wp-3-5/
* Setting name is taken from the part in [] in the name attributes. That's the array key value that goes
* to the validation function.
*/
function flh_announcements_options_field_ticker_color() {
$defaults = flh_announcements_get_default_options();
$options = flh_announcements_get_options();
?>
' . $defaults['ticker-height'] . '' ); ?>
' . $defaults['max-chars'] . '' ); ?>
' . $defaults['text-size'] . '' ); ?>
section and thus puts the options into effect.
*
* Method adapted from twenty eleven's implementation of link colour.
*/
function flh_announcements_print_ticker_color_style() {
$defaults = flh_announcements_get_default_options();
$options = flh_announcements_get_options();
?>