wordpress-starter 0.1 → 0.2

data/templates/starter/inc/template-tags.php

@@ -0,0 +1,175 @@
+<?php
+/**
+ * Custom template tags for this theme.
+ *
+ * Eventually, some of the functionality here could be replaced by core features
+ *
+ * @package starter
+ * @since starter 1.0
+ */
+
+if ( ! function_exists( 'starter_content_nav' ) ) :
+/**
+ * Display navigation to next/previous pages when applicable
+ *
+ * @since starter 1.0
+ */
+function starter_content_nav( $nav_id ) {
+	global $wp_query, $post;
+
+	// Don't print empty markup on single pages if there's nowhere to navigate.
+	if ( is_single() ) {
+		$previous = ( is_attachment() ) ? get_post( $post->post_parent ) : get_adjacent_post( false, '', true );
+		$next = get_adjacent_post( false, '', false );
+
+		if ( ! $next && ! $previous )
+			return;
+	}
+
+	// Don't print empty markup in archives if there's only one page.
+	if ( $wp_query->max_num_pages < 2 && ( is_home() || is_archive() || is_search() ) )
+		return;
+
+	$nav_class = 'site-navigation paging-navigation';
+	if ( is_single() )
+		$nav_class = 'site-navigation post-navigation';
+
+	?>
+	<nav role="navigation" id="<?php echo $nav_id; ?>" class="<?php echo $nav_class; ?>">
+		<h1 class="assistive-text"><?php _e( 'Post navigation', 'starter' ); ?></h1>
+
+	<?php if ( is_single() ) : // navigation links for single posts ?>
+
+		<?php previous_post_link( '<div class="nav-previous">%link</div>', '<span class="meta-nav">' . _x( '&larr;', 'Previous post link', 'starter' ) . '</span> %title' ); ?>
+		<?php next_post_link( '<div class="nav-next">%link</div>', '%title <span class="meta-nav">' . _x( '&rarr;', 'Next post link', 'starter' ) . '</span>' ); ?>
+
+	<?php elseif ( $wp_query->max_num_pages > 1 && ( is_home() || is_archive() || is_search() ) ) : // navigation links for home, archive, and search pages ?>
+
+		<?php if ( get_next_posts_link() ) : ?>
+		<div class="nav-previous"><?php next_posts_link( __( '<span class="meta-nav">&larr;</span> Older posts', 'starter' ) ); ?></div>
+		<?php endif; ?>
+
+		<?php if ( get_previous_posts_link() ) : ?>
+		<div class="nav-next"><?php previous_posts_link( __( 'Newer posts <span class="meta-nav">&rarr;</span>', 'starter' ) ); ?></div>
+		<?php endif; ?>
+
+	<?php endif; ?>
+
+	</nav><!-- #<?php echo $nav_id; ?> -->
+	<?php
+}
+endif; // starter_content_nav
+
+if ( ! function_exists( 'starter_comment' ) ) :
+/**
+ * Template for comments and pingbacks.
+ *
+ * Used as a callback by wp_list_comments() for displaying the comments.
+ *
+ * @since starter 1.0
+ */
+function starter_comment( $comment, $args, $depth ) {
+	$GLOBALS['comment'] = $comment;
+	switch ( $comment->comment_type ) :
+		case 'pingback' :
+		case 'trackback' :
+	?>
+	<li class="post pingback">
+		<p><?php _e( 'Pingback:', 'starter' ); ?> <?php comment_author_link(); ?><?php edit_comment_link( __( '(Edit)', 'starter' ), ' ' ); ?></p>
+	<?php
+			break;
+		default :
+	?>
+	<li <?php comment_class(); ?> id="li-comment-<?php comment_ID(); ?>">
+		<article id="comment-<?php comment_ID(); ?>" class="comment">
+			<footer>
+				<div class="comment-author vcard">
+					<?php echo get_avatar( $comment, 40 ); ?>
+					<?php printf( __( '%s <span class="says">says:</span>', 'starter' ), sprintf( '<cite class="fn">%s</cite>', get_comment_author_link() ) ); ?>
+				</div><!-- .comment-author .vcard -->
+				<?php if ( $comment->comment_approved == '0' ) : ?>
+					<em><?php _e( 'Your comment is awaiting moderation.', 'starter' ); ?></em>
+					<br />
+				<?php endif; ?>
+
+				<div class="comment-meta commentmetadata">
+					<a href="<?php echo esc_url( get_comment_link( $comment->comment_ID ) ); ?>"><time pubdate datetime="<?php comment_time( 'c' ); ?>">
+					<?php
+						/* translators: 1: date, 2: time */
+						printf( __( '%1$s at %2$s', 'starter' ), get_comment_date(), get_comment_time() ); ?>
+					</time></a>
+					<?php edit_comment_link( __( '(Edit)', 'starter' ), ' ' );
+					?>
+				</div><!-- .comment-meta .commentmetadata -->
+			</footer>
+
+			<div class="comment-content"><?php comment_text(); ?></div>
+
+			<div class="reply">
+				<?php comment_reply_link( array_merge( $args, array( 'depth' => $depth, 'max_depth' => $args['max_depth'] ) ) ); ?>
+			</div><!-- .reply -->
+		</article><!-- #comment-## -->
+
+	<?php
+			break;
+	endswitch;
+}
+endif; // ends check for starter_comment()
+
+if ( ! function_exists( 'starter_posted_on' ) ) :
+/**
+ * Prints HTML with meta information for the current post-date/time and author.
+ *
+ * @since starter 1.0
+ */
+function starter_posted_on() {
+	printf( __( 'Posted on <a href="%1$s" title="%2$s" rel="bookmark"><time class="entry-date" datetime="%3$s" pubdate>%4$s</time></a><span class="byline"> by <span class="author vcard"><a class="url fn n" href="%5$s" title="%6$s" rel="author">%7$s</a></span></span>', 'starter' ),
+		esc_url( get_permalink() ),
+		esc_attr( get_the_time() ),
+		esc_attr( get_the_date( 'c' ) ),
+		esc_html( get_the_date() ),
+		esc_url( get_author_posts_url( get_the_author_meta( 'ID' ) ) ),
+		esc_attr( sprintf( __( 'View all posts by %s', 'starter' ), get_the_author() ) ),
+		esc_html( get_the_author() )
+	);
+}
+endif;
+
+/**
+ * Returns true if a blog has more than 1 category
+ *
+ * @since starter 1.0
+ */
+function starter_categorized_blog() {
+	if ( false === ( $all_the_cool_cats = get_transient( 'all_the_cool_cats' ) ) ) {
+		// Create an array of all the categories that are attached to posts
+		$all_the_cool_cats = get_categories( array(
+			'hide_empty' => 1,
+		) );
+
+		// Count the number of categories that are attached to the posts
+		$all_the_cool_cats = count( $all_the_cool_cats );
+
+		set_transient( 'all_the_cool_cats', $all_the_cool_cats );
+	}
+
+	if ( '1' != $all_the_cool_cats ) {
+		// This blog has more than 1 category so starter_categorized_blog should return true
+		return true;
+	} else {
+		// This blog has only 1 category so starter_categorized_blog should return false
+		return false;
+	}
+}
+
+/**
+ * Flush out the transients used in starter_categorized_blog
+ *
+ * @since starter 1.0
+ */
+function starter_category_transient_flusher() {
+	// Like, beat it. Dig?
+	delete_transient( 'all_the_cool_cats' );
+}
+add_action( 'edit_category', 'starter_category_transient_flusher' );
+add_action( 'save_post', 'starter_category_transient_flusher' );

data/templates/starter/inc/theme-options/theme-options.php

@@ -0,0 +1,306 @@
+<?php
+/**
+ * starter Theme Options
+ *
+ * @package starter
+ * @since starter 1.0
+ */
+
+/**
+ * Register the form setting for our starter_options array.
+ *
+ * This function is attached to the admin_init action hook.
+ *
+ * This call to register_setting() registers a validation callback, starter_theme_options_validate(),
+ * which is used when the option is saved, to ensure that our option values are properly
+ * formatted, and safe.
+ *
+ * @since starter 1.0
+ */
+function starter_theme_options_init() {
+	register_setting(
+		'starter_options', // Options group, see settings_fields() call in starter_theme_options_render_page()
+		'starter_theme_options', // Database option, see starter_get_theme_options()
+		'starter_theme_options_validate' // The sanitization callback, see starter_theme_options_validate()
+	);
+
+	// Register our settings field group
+	add_settings_section(
+		'general', // Unique identifier for the settings section
+		'', // Section title (we don't want one)
+		'__return_false', // Section callback (we don't want anything)
+		'theme_options' // Menu slug, used to uniquely identify the page; see starter_theme_options_add_page()
+	);
+
+	// Register our individual settings fields
+	add_settings_field(
+		'sample_checkbox', // Unique identifier for the field for this section
+		__( 'Sample Checkbox', 'starter' ), // Setting field label
+		'starter_settings_field_sample_checkbox', // Function that renders the settings field
+		'theme_options', // Menu slug, used to uniquely identify the page; see starter_theme_options_add_page()
+		'general' // Settings section. Same as the first argument in the add_settings_section() above
+	);
+
+	add_settings_field( 'sample_text_input', __( 'Sample Text Input', 'starter' ), 'starter_settings_field_sample_text_input', 'theme_options', 'general' );
+	add_settings_field( 'sample_select_options', __( 'Sample Select Options', 'starter' ), 'starter_settings_field_sample_select_options', 'theme_options', 'general' );
+	add_settings_field( 'sample_radio_buttons', __( 'Sample Radio Buttons', 'starter' ), 'starter_settings_field_sample_radio_buttons', 'theme_options', 'general' );
+	add_settings_field( 'sample_textarea', __( 'Sample Textarea', 'starter' ), 'starter_settings_field_sample_textarea', 'theme_options', 'general' );
+}
+add_action( 'admin_init', 'starter_theme_options_init' );
+
+/**
+ * Change the capability required to save the 'starter_options' options group.
+ *
+ * @see starter_theme_options_init() First parameter to register_setting() is the name of the options group.
+ * @see starter_theme_options_add_page() The edit_theme_options capability is used for viewing the page.
+ *
+ * @param string $capability The capability used for the page, which is manage_options by default.
+ * @return string The capability to actually use.
+ */
+function starter_option_page_capability( $capability ) {
+	return 'edit_theme_options';
+}
+add_filter( 'option_page_capability_starter_options', 'starter_option_page_capability' );
+
+/**
+ * Add our theme options page to the admin menu.
+ *
+ * This function is attached to the admin_menu action hook.
+ *
+ * @since starter 1.0
+ */
+function starter_theme_options_add_page() {
+	$theme_page = add_theme_page(
+		__( 'Theme Options', 'starter' ),   // Name of page
+		__( 'Theme Options', 'starter' ),   // Label in menu
+		'edit_theme_options',          // Capability required
+		'theme_options',               // Menu slug, used to uniquely identify the page
+		'starter_theme_options_render_page' // Function that renders the options page
+	);
+}
+add_action( 'admin_menu', 'starter_theme_options_add_page' );
+
+/**
+ * Returns an array of sample select options registered for starter.
+ *
+ * @since starter 1.0
+ */
+function starter_sample_select_options() {
+	$sample_select_options = array(
+		'0' => array(
+			'value' =>	'0',
+			'label' => __( 'Zero', 'starter' )
+		),
+		'1' => array(
+			'value' =>	'1',
+			'label' => __( 'One', 'starter' )
+		),
+		'2' => array(
+			'value' => '2',
+			'label' => __( 'Two', 'starter' )
+		),
+		'3' => array(
+			'value' => '3',
+			'label' => __( 'Three', 'starter' )
+		),
+		'4' => array(
+			'value' => '4',
+			'label' => __( 'Four', 'starter' )
+		),
+		'5' => array(
+			'value' => '5',
+			'label' => __( 'Five', 'starter' )
+		)
+	);
+
+	return apply_filters( 'starter_sample_select_options', $sample_select_options );
+}
+
+/**
+ * Returns an array of sample radio options registered for starter.
+ *
+ * @since starter 1.0
+ */
+function starter_sample_radio_buttons() {
+	$sample_radio_buttons = array(
+		'yes' => array(
+			'value' => 'yes',
+			'label' => __( 'Yes', 'starter' )
+		),
+		'no' => array(
+			'value' => 'no',
+			'label' => __( 'No', 'starter' )
+		),
+		'maybe' => array(
+			'value' => 'maybe',
+			'label' => __( 'Maybe', 'starter' )
+		)
+	);
+
+	return apply_filters( 'starter_sample_radio_buttons', $sample_radio_buttons );
+}
+
+/**
+ * Returns the options array for starter.
+ *
+ * @since starter 1.0
+ */
+function starter_get_theme_options() {
+	$saved = (array) get_option( 'starter_theme_options' );
+	$defaults = array(
+		'sample_checkbox'       => 'off',
+		'sample_text_input'     => '',
+		'sample_select_options' => '',
+		'sample_radio_buttons'  => '',
+		'sample_textarea'       => '',
+	);
+
+	$defaults = apply_filters( 'starter_default_theme_options', $defaults );
+
+	$options = wp_parse_args( $saved, $defaults );
+	$options = array_intersect_key( $options, $defaults );
+
+	return $options;
+}
+
+/**
+ * Renders the sample checkbox setting field.
+ */
+function starter_settings_field_sample_checkbox() {
+	$options = starter_get_theme_options();
+	?>
+	<label for="sample-checkbox">
+		<input type="checkbox" name="starter_theme_options[sample_checkbox]" id="sample-checkbox" <?php checked( 'on', $options['sample_checkbox'] ); ?> />
+		<?php _e( 'A sample checkbox.', 'starter' ); ?>
+	</label>
+	<?php
+}
+
+/**
+ * Renders the sample text input setting field.
+ */
+function starter_settings_field_sample_text_input() {
+	$options = starter_get_theme_options();
+	?>
+	<input type="text" name="starter_theme_options[sample_text_input]" id="sample-text-input" value="<?php echo esc_attr( $options['sample_text_input'] ); ?>" />
+	<label class="description" for="sample-text-input"><?php _e( 'Sample text input', 'starter' ); ?></label>
+	<?php
+}
+
+/**
+ * Renders the sample select options setting field.
+ */
+function starter_settings_field_sample_select_options() {
+	$options = starter_get_theme_options();
+	?>
+	<select name="starter_theme_options[sample_select_options]" id="sample-select-options">
+		<?php
+			$selected = $options['sample_select_options'];
+			$p = '';
+			$r = '';
+
+			foreach ( starter_sample_select_options() as $option ) {
+				$label = $option['label'];
+				if ( $selected == $option['value'] ) // Make default first in list
+					$p = "\n\t<option style=\"padding-right: 10px;\" selected='selected' value='" . esc_attr( $option['value'] ) . "'>$label</option>";
+				else
+					$r .= "\n\t<option style=\"padding-right: 10px;\" value='" . esc_attr( $option['value'] ) . "'>$label</option>";
+			}
+			echo $p . $r;
+		?>
+	</select>
+	<label class="description" for="sample_theme_options[selectinput]"><?php _e( 'Sample select input', 'starter' ); ?></label>
+	<?php
+}
+
+/**
+ * Renders the radio options setting field.
+ *
+ * @since starter 1.0
+ */
+function starter_settings_field_sample_radio_buttons() {
+	$options = starter_get_theme_options();
+
+	foreach ( starter_sample_radio_buttons() as $button ) {
+	?>
+	<div class="layout">
+		<label class="description">
+			<input type="radio" name="starter_theme_options[sample_radio_buttons]" value="<?php echo esc_attr( $button['value'] ); ?>" <?php checked( $options['sample_radio_buttons'], $button['value'] ); ?> />
+			<?php echo $button['label']; ?>
+		</label>
+	</div>
+	<?php
+	}
+}
+
+/**
+ * Renders the sample textarea setting field.
+ */
+function starter_settings_field_sample_textarea() {
+	$options = starter_get_theme_options();
+	?>
+	<textarea class="large-text" type="text" name="starter_theme_options[sample_textarea]" id="sample-textarea" cols="50" rows="10" /><?php echo esc_textarea( $options['sample_textarea'] ); ?></textarea>
+	<label class="description" for="sample-textarea"><?php _e( 'Sample textarea', 'starter' ); ?></label>
+	<?php
+}
+
+/**
+ * Renders the Theme Options administration screen.
+ *
+ * @since starter 1.0
+ */
+function starter_theme_options_render_page() {
+	?>
+	<div class="wrap">
+		<?php screen_icon(); ?>
+		<?php $theme_name = function_exists( 'wp_get_theme' ) ? wp_get_theme() : get_current_theme(); ?>
+		<h2><?php printf( __( '%s Theme Options', 'starter' ), $theme_name ); ?></h2>
+		<?php settings_errors(); ?>
+
+		<form method="post" action="options.php">
+			<?php
+				settings_fields( 'starter_options' );
+				do_settings_sections( 'theme_options' );
+				submit_button();
+			?>
+		</form>
+	</div>
+	<?php
+}
+
+/**
+ * Sanitize and validate form input. Accepts an array, return a sanitized array.
+ *
+ * @see starter_theme_options_init()
+ * @todo set up Reset Options action
+ *
+ * @param array $input Unknown values.
+ * @return array Sanitized theme options ready to be stored in the database.
+ *
+ * @since starter 1.0
+ */
+function starter_theme_options_validate( $input ) {
+	$output = array();
+
+	// Checkboxes will only be present if checked.
+	if ( isset( $input['sample_checkbox'] ) )
+		$output['sample_checkbox'] = 'on';
+
+	// The sample text input must be safe text with no HTML tags
+	if ( isset( $input['sample_text_input'] ) && ! empty( $input['sample_text_input'] ) )
+		$output['sample_text_input'] = wp_filter_nohtml_kses( $input['sample_text_input'] );
+
+	// The sample select option must actually be in the array of select options
+	if ( isset( $input['sample_select_options'] ) && array_key_exists( $input['sample_select_options'], starter_sample_select_options() ) )
+		$output['sample_select_options'] = $input['sample_select_options'];
+
+	// The sample radio button value must be in our array of radio button values
+	if ( isset( $input['sample_radio_buttons'] ) && array_key_exists( $input['sample_radio_buttons'], starter_sample_radio_buttons() ) )
+		$output['sample_radio_buttons'] = $input['sample_radio_buttons'];
+
+	// The sample textarea must be safe text with the allowed tags for posts
+	if ( isset( $input['sample_textarea'] ) && ! empty( $input['sample_textarea'] ) )
+		$output['sample_textarea'] = wp_filter_post_kses( $input['sample_textarea'] );
+
+	return apply_filters( 'starter_theme_options_validate', $output, $input );
+}