wp-content/themes/twentythirteen/functions.php

   1 <?php
   2 /**
   3  * Twenty Thirteen functions and definitions
   4  *
   5  * Sets up the theme and provides some helper functions, which are used in the
   6  * theme as custom template tags. Others are attached to action and filter
   7  * hooks in WordPress to change core functionality.
   8  *
   9  * When using a child theme (see http://codex.wordpress.org/Theme_Development
  10  * and http://codex.wordpress.org/Child_Themes), you can override certain
  11  * functions (those wrapped in a function_exists() call) by defining them first
  12  * in your child theme's functions.php file. The child theme's functions.php
  13  * file is included before the parent theme's file, so the child theme
  14  * functions would be used.
  15  *
  16  * Functions that are not pluggable (not wrapped in function_exists()) are
  17  * instead attached to a filter or action hook.
  18  *
  19  * For more information on hooks, actions, and filters, @link http://codex.wordpress.org/Plugin_API
  20  *
  21  * @package WordPress
  22  * @subpackage Twenty_Thirteen
  23  * @since Twenty Thirteen 1.0
  24  */
  25
  26 /*
  27  * Set up the content width value based on the theme's design.
  28  *
  29  * @see twentythirteen_content_width() for template-specific adjustments.
  30  */
  31 if ( ! isset( $content_width ) )
  32         $content_width = 604;
  33
  34 /**
  35  * Add support for a custom header image.
  36  */
  37 require get_template_directory() . '/inc/custom-header.php';
  38
  39 /**
  40  * Twenty Thirteen only works in WordPress 3.6 or later.
  41  */
  42 if ( version_compare( $GLOBALS['wp_version'], '3.6-alpha', '<' ) )
  43         require get_template_directory() . '/inc/back-compat.php';
  44
  45 /**
  46  * Twenty Thirteen setup.
  47  *
  48  * Sets up theme defaults and registers the various WordPress features that
  49  * Twenty Thirteen supports.
  50  *
  51  * @uses load_theme_textdomain() For translation/localization support.
  52  * @uses add_editor_style() To add Visual Editor stylesheets.
  53  * @uses add_theme_support() To add support for automatic feed links, post
  54  * formats, and post thumbnails.
  55  * @uses register_nav_menu() To add support for a navigation menu.
  56  * @uses set_post_thumbnail_size() To set a custom post thumbnail size.
  57  *
  58  * @since Twenty Thirteen 1.0
  59  *
  60  * @return void
  61  */
  62 function twentythirteen_setup() {
  63         /*
  64          * Makes Twenty Thirteen available for translation.
  65          *
  66          * Translations can be added to the /languages/ directory.
  67          * If you're building a theme based on Twenty Thirteen, use a find and
  68          * replace to change 'twentythirteen' to the name of your theme in all
  69          * template files.
  70          */
  71         load_theme_textdomain( 'twentythirteen', get_template_directory() . '/languages' );
  72
  73         /*
  74          * This theme styles the visual editor to resemble the theme style,
  75          * specifically font, colors, icons, and column width.
  76          */
  77         add_editor_style( array( 'css/editor-style.css', 'fonts/genericons.css', twentythirteen_fonts_url() ) );
  78
  79         // Adds RSS feed links to <head> for posts and comments.
  80         add_theme_support( 'automatic-feed-links' );
  81
  82         /*
  83          * Switches default core markup for search form, comment form,
  84          * and comments to output valid HTML5.
  85          */
  86         add_theme_support( 'html5', array( 'search-form', 'comment-form', 'comment-list' ) );
  87
  88         /*
  89          * This theme supports all available post formats by default.
  90          * See http://codex.wordpress.org/Post_Formats
  91          */
  92         add_theme_support( 'post-formats', array(
  93                 'aside', 'audio', 'chat', 'gallery', 'image', 'link', 'quote', 'status', 'video'
  94         ) );
  95
  96         // This theme uses wp_nav_menu() in one location.
  97         register_nav_menu( 'primary', __( 'Navigation Menu', 'twentythirteen' ) );
  98
  99         /*
 100          * This theme uses a custom image size for featured images, displayed on
 101          * "standard" posts and pages.
 102          */
 103         add_theme_support( 'post-thumbnails' );
 104         set_post_thumbnail_size( 604, 270, true );
 105
 106         // This theme uses its own gallery styles.
 107         add_filter( 'use_default_gallery_style', '__return_false' );
 108 }
 109 add_action( 'after_setup_theme', 'twentythirteen_setup' );
 110
 111 /**
 112  * Return the Google font stylesheet URL, if available.
 113  *
 114  * The use of Source Sans Pro and Bitter by default is localized. For languages
 115  * that use characters not supported by the font, the font can be disabled.
 116  *
 117  * @since Twenty Thirteen 1.0
 118  *
 119  * @return string Font stylesheet or empty string if disabled.
 120  */
 121 function twentythirteen_fonts_url() {
 122         $fonts_url = '';
 123
 124         /* Translators: If there are characters in your language that are not
 125          * supported by Source Sans Pro, translate this to 'off'. Do not translate
 126          * into your own language.
 127          */
 128         $source_sans_pro = _x( 'on', 'Source Sans Pro font: on or off', 'twentythirteen' );
 129
 130         /* Translators: If there are characters in your language that are not
 131          * supported by Bitter, translate this to 'off'. Do not translate into your
 132          * own language.
 133          */
 134         $bitter = _x( 'on', 'Bitter font: on or off', 'twentythirteen' );
 135
 136         if ( 'off' !== $source_sans_pro || 'off' !== $bitter ) {
 137                 $font_families = array();
 138
 139                 if ( 'off' !== $source_sans_pro )
 140                         $font_families[] = 'Source Sans Pro:300,400,700,300italic,400italic,700italic';
 141
 142                 if ( 'off' !== $bitter )
 143                         $font_families[] = 'Bitter:400,700';
 144
 145                 $query_args = array(
 146                         'family' => urlencode( implode( '|', $font_families ) ),
 147                         'subset' => urlencode( 'latin,latin-ext' ),
 148                 );
 149                 $fonts_url = add_query_arg( $query_args, "//fonts.googleapis.com/css" );
 150         }
 151
 152         return $fonts_url;
 153 }
 154
 155 /**
 156  * Enqueue scripts and styles for the front end.
 157  *
 158  * @since Twenty Thirteen 1.0
 159  *
 160  * @return void
 161  */
 162 function twentythirteen_scripts_styles() {
 163         /*
 164          * Adds JavaScript to pages with the comment form to support
 165          * sites with threaded comments (when in use).
 166          */
 167         if ( is_singular() && comments_open() && get_option( 'thread_comments' ) )
 168                 wp_enqueue_script( 'comment-reply' );
 169
 170         // Adds Masonry to handle vertical alignment of footer widgets.
 171         if ( is_active_sidebar( 'sidebar-1' ) )
 172                 wp_enqueue_script( 'jquery-masonry' );
 173
 174         // Loads JavaScript file with functionality specific to Twenty Thirteen.
 175         wp_enqueue_script( 'twentythirteen-script', get_template_directory_uri() . '/js/functions.js', array( 'jquery' ), '2013-07-18', true );
 176
 177         // Add Source Sans Pro and Bitter fonts, used in the main stylesheet.
 178         wp_enqueue_style( 'twentythirteen-fonts', twentythirteen_fonts_url(), array(), null );
 179
 180         // Add Genericons font, used in the main stylesheet.
 181         wp_enqueue_style( 'genericons', get_template_directory_uri() . '/fonts/genericons.css', array(), '2.09' );
 182
 183         // Loads our main stylesheet.
 184         wp_enqueue_style( 'twentythirteen-style', get_stylesheet_uri(), array(), '2013-07-18' );
 185
 186         // Loads the Internet Explorer specific stylesheet.
 187         wp_enqueue_style( 'twentythirteen-ie', get_template_directory_uri() . '/css/ie.css', array( 'twentythirteen-style' ), '2013-07-18' );
 188         wp_style_add_data( 'twentythirteen-ie', 'conditional', 'lt IE 9' );
 189 }
 190 add_action( 'wp_enqueue_scripts', 'twentythirteen_scripts_styles' );
 191
 192 /**
 193  * Filter the page title.
 194  *
 195  * Creates a nicely formatted and more specific title element text for output
 196  * in head of document, based on current view.
 197  *
 198  * @since Twenty Thirteen 1.0
 199  *
 200  * @param string $title Default title text for current view.
 201  * @param string $sep   Optional separator.
 202  * @return string The filtered title.
 203  */
 204 function twentythirteen_wp_title( $title, $sep ) {
 205         global $paged, $page;
 206
 207         if ( is_feed() )
 208                 return $title;
 209
 210         // Add the site name.
 211         $title .= get_bloginfo( 'name' );
 212
 213         // Add the site description for the home/front page.
 214         $site_description = get_bloginfo( 'description', 'display' );
 215         if ( $site_description && ( is_home() || is_front_page() ) )
 216                 $title = "$title $sep $site_description";
 217
 218         // Add a page number if necessary.
 219         if ( $paged >= 2 || $page >= 2 )
 220                 $title = "$title $sep " . sprintf( __( 'Page %s', 'twentythirteen' ), max( $paged, $page ) );
 221
 222         return $title;
 223 }
 224 add_filter( 'wp_title', 'twentythirteen_wp_title', 10, 2 );
 225
 226 /**
 227  * Register two widget areas.
 228  *
 229  * @since Twenty Thirteen 1.0
 230  *
 231  * @return void
 232  */
 233 function twentythirteen_widgets_init() {
 234         register_sidebar( array(
 235                 'name'          => __( 'Main Widget Area', 'twentythirteen' ),
 236                 'id'            => 'sidebar-1',
 237                 'description'   => __( 'Appears in the footer section of the site.', 'twentythirteen' ),
 238                 'before_widget' => '<aside id="%1$s" class="widget %2$s">',
 239                 'after_widget'  => '</aside>',
 240                 'before_title'  => '<h3 class="widget-title">',
 241                 'after_title'   => '</h3>',
 242         ) );
 243
 244         register_sidebar( array(
 245                 'name'          => __( 'Secondary Widget Area', 'twentythirteen' ),
 246                 'id'            => 'sidebar-2',
 247                 'description'   => __( 'Appears on posts and pages in the sidebar.', 'twentythirteen' ),
 248                 'before_widget' => '<aside id="%1$s" class="widget %2$s">',
 249                 'after_widget'  => '</aside>',
 250                 'before_title'  => '<h3 class="widget-title">',
 251                 'after_title'   => '</h3>',
 252         ) );
 253 }
 254 add_action( 'widgets_init', 'twentythirteen_widgets_init' );
 255
 256 if ( ! function_exists( 'twentythirteen_paging_nav' ) ) :
 257 /**
 258  * Display navigation to next/previous set of posts when applicable.
 259  *
 260  * @since Twenty Thirteen 1.0
 261  *
 262  * @return void
 263  */
 264 function twentythirteen_paging_nav() {
 265         global $wp_query;
 266
 267         // Don't print empty markup if there's only one page.
 268         if ( $wp_query->max_num_pages < 2 )
 269                 return;
 270         ?>
 271         <nav class="navigation paging-navigation" role="navigation">
 272                 <h1 class="screen-reader-text"><?php _e( 'Posts navigation', 'twentythirteen' ); ?></h1>
 273                 <div class="nav-links">
 274
 275                         <?php if ( get_next_posts_link() ) : ?>
 276                         <div class="nav-previous"><?php next_posts_link( __( '<span class="meta-nav">&larr;</span> Older posts', 'twentythirteen' ) ); ?></div>
 277                         <?php endif; ?>
 278
 279                         <?php if ( get_previous_posts_link() ) : ?>
 280                         <div class="nav-next"><?php previous_posts_link( __( 'Newer posts <span class="meta-nav">&rarr;</span>', 'twentythirteen' ) ); ?></div>
 281                         <?php endif; ?>
 282
 283                 </div><!-- .nav-links -->
 284         </nav><!-- .navigation -->
 285         <?php
 286 }
 287 endif;
 288
 289 if ( ! function_exists( 'twentythirteen_post_nav' ) ) :
 290 /**
 291  * Display navigation to next/previous post when applicable.
 292 *
 293 * @since Twenty Thirteen 1.0
 294 *
 295 * @return void
 296 */
 297 function twentythirteen_post_nav() {
 298         global $post;
 299
 300         // Don't print empty markup if there's nowhere to navigate.
 301         $previous = ( is_attachment() ) ? get_post( $post->post_parent ) : get_adjacent_post( false, '', true );
 302         $next     = get_adjacent_post( false, '', false );
 303
 304         if ( ! $next && ! $previous )
 305                 return;
 306         ?>
 307         <nav class="navigation post-navigation" role="navigation">
 308                 <h1 class="screen-reader-text"><?php _e( 'Post navigation', 'twentythirteen' ); ?></h1>
 309                 <div class="nav-links">
 310
 311                         <?php previous_post_link( '%link', _x( '<span class="meta-nav">&larr;</span> %title', 'Previous post link', 'twentythirteen' ) ); ?>
 312                         <?php next_post_link( '%link', _x( '%title <span class="meta-nav">&rarr;</span>', 'Next post link', 'twentythirteen' ) ); ?>
 313
 314                 </div><!-- .nav-links -->
 315         </nav><!-- .navigation -->
 316         <?php
 317 }
 318 endif;
 319
 320 if ( ! function_exists( 'twentythirteen_entry_meta' ) ) :
 321 /**
 322  * Print HTML with meta information for current post: categories, tags, permalink, author, and date.
 323  *
 324  * Create your own twentythirteen_entry_meta() to override in a child theme.
 325  *
 326  * @since Twenty Thirteen 1.0
 327  *
 328  * @return void
 329  */
 330 function twentythirteen_entry_meta() {
 331         if ( is_sticky() && is_home() && ! is_paged() )
 332                 echo '<span class="featured-post">' . __( 'Sticky', 'twentythirteen' ) . '</span>';
 333
 334         if ( ! has_post_format( 'link' ) && 'post' == get_post_type() )
 335                 twentythirteen_entry_date();
 336
 337         // Translators: used between list items, there is a space after the comma.
 338         $categories_list = get_the_category_list( __( ', ', 'twentythirteen' ) );
 339         if ( $categories_list ) {
 340                 echo '<span class="categories-links">' . $categories_list . '</span>';
 341         }
 342
 343         // Translators: used between list items, there is a space after the comma.
 344         $tag_list = get_the_tag_list( '', __( ', ', 'twentythirteen' ) );
 345         if ( $tag_list ) {
 346                 echo '<span class="tags-links">' . $tag_list . '</span>';
 347         }
 348
 349         // Post author
 350         if ( 'post' == get_post_type() ) {
 351                 printf( '<span class="author vcard"><a class="url fn n" href="%1$s" title="%2$s" rel="author">%3$s</a></span>',
 352                         esc_url( get_author_posts_url( get_the_author_meta( 'ID' ) ) ),
 353                         esc_attr( sprintf( __( 'View all posts by %s', 'twentythirteen' ), get_the_author() ) ),
 354                         get_the_author()
 355                 );
 356         }
 357 }
 358 endif;
 359
 360 if ( ! function_exists( 'twentythirteen_entry_date' ) ) :
 361 /**
 362  * Print HTML with date information for current post.
 363  *
 364  * Create your own twentythirteen_entry_date() to override in a child theme.
 365  *
 366  * @since Twenty Thirteen 1.0
 367  *
 368  * @param boolean $echo (optional) Whether to echo the date. Default true.
 369  * @return string The HTML-formatted post date.
 370  */
 371 function twentythirteen_entry_date( $echo = true ) {
 372         if ( has_post_format( array( 'chat', 'status' ) ) )
 373                 $format_prefix = _x( '%1$s on %2$s', '1: post format name. 2: date', 'twentythirteen' );
 374         else
 375                 $format_prefix = '%2$s';
 376
 377         $date = sprintf( '<span class="date"><a href="%1$s" title="%2$s" rel="bookmark"><time class="entry-date" datetime="%3$s">%4$s</time></a></span>',
 378                 esc_url( get_permalink() ),
 379                 esc_attr( sprintf( __( 'Permalink to %s', 'twentythirteen' ), the_title_attribute( 'echo=0' ) ) ),
 380                 esc_attr( get_the_date( 'c' ) ),
 381                 esc_html( sprintf( $format_prefix, get_post_format_string( get_post_format() ), get_the_date() ) )
 382         );
 383
 384         if ( $echo )
 385                 echo $date;
 386
 387         return $date;
 388 }
 389 endif;
 390
 391 if ( ! function_exists( 'twentythirteen_the_attached_image' ) ) :
 392 /**
 393  * Print the attached image with a link to the next attached image.
 394  *
 395  * @since Twenty Thirteen 1.0
 396  *
 397  * @return void
 398  */
 399 function twentythirteen_the_attached_image() {
 400         /**
 401          * Filter the image attachment size to use.
 402          *
 403          * @since Twenty thirteen 1.0
 404          *
 405          * @param array $size {
 406          *     @type int The attachment height in pixels.
 407          *     @type int The attachment width in pixels.
 408          * }
 409          */
 410         $attachment_size     = apply_filters( 'twentythirteen_attachment_size', array( 724, 724 ) );
 411         $next_attachment_url = wp_get_attachment_url();
 412         $post                = get_post();
 413
 414         /*
 415          * Grab the IDs of all the image attachments in a gallery so we can get the URL
 416          * of the next adjacent image in a gallery, or the first image (if we're
 417          * looking at the last image in a gallery), or, in a gallery of one, just the
 418          * link to that image file.
 419          */
 420         $attachment_ids = get_posts( array(
 421                 'post_parent'    => $post->post_parent,
 422                 'fields'         => 'ids',
 423                 'numberposts'    => -1,
 424                 'post_status'    => 'inherit',
 425                 'post_type'      => 'attachment',
 426                 'post_mime_type' => 'image',
 427                 'order'          => 'ASC',
 428                 'orderby'        => 'menu_order ID'
 429         ) );
 430
 431         // If there is more than 1 attachment in a gallery...
 432         if ( count( $attachment_ids ) > 1 ) {
 433                 foreach ( $attachment_ids as $attachment_id ) {
 434                         if ( $attachment_id == $post->ID ) {
 435                                 $next_id = current( $attachment_ids );
 436                                 break;
 437                         }
 438                 }
 439
 440                 // get the URL of the next image attachment...
 441                 if ( $next_id )
 442                         $next_attachment_url = get_attachment_link( $next_id );
 443
 444                 // or get the URL of the first image attachment.
 445                 else
 446                         $next_attachment_url = get_attachment_link( array_shift( $attachment_ids ) );
 447         }
 448
 449         printf( '<a href="%1$s" title="%2$s" rel="attachment">%3$s</a>',
 450                 esc_url( $next_attachment_url ),
 451                 the_title_attribute( array( 'echo' => false ) ),
 452                 wp_get_attachment_image( $post->ID, $attachment_size )
 453         );
 454 }
 455 endif;
 456
 457 /**
 458  * Return the post URL.
 459  *
 460  * @uses get_url_in_content() to get the URL in the post meta (if it exists) or
 461  * the first link found in the post content.
 462  *
 463  * Falls back to the post permalink if no URL is found in the post.
 464  *
 465  * @since Twenty Thirteen 1.0
 466  *
 467  * @return string The Link format URL.
 468  */
 469 function twentythirteen_get_link_url() {
 470         $content = get_the_content();
 471         $has_url = get_url_in_content( $content );
 472
 473         return ( $has_url ) ? $has_url : apply_filters( 'the_permalink', get_permalink() );
 474 }
 475
 476 /**
 477  * Extend the default WordPress body classes.
 478  *
 479  * Adds body classes to denote:
 480  * 1. Single or multiple authors.
 481  * 2. Active widgets in the sidebar to change the layout and spacing.
 482  * 3. When avatars are disabled in discussion settings.
 483  *
 484  * @since Twenty Thirteen 1.0
 485  *
 486  * @param array $classes A list of existing body class values.
 487  * @return array The filtered body class list.
 488  */
 489 function twentythirteen_body_class( $classes ) {
 490         if ( ! is_multi_author() )
 491                 $classes[] = 'single-author';
 492
 493         if ( is_active_sidebar( 'sidebar-2' ) && ! is_attachment() && ! is_404() )
 494                 $classes[] = 'sidebar';
 495
 496         if ( ! get_option( 'show_avatars' ) )
 497                 $classes[] = 'no-avatars';
 498
 499         return $classes;
 500 }
 501 add_filter( 'body_class', 'twentythirteen_body_class' );
 502
 503 /**
 504  * Adjust content_width value for video post formats and attachment templates.
 505  *
 506  * @since Twenty Thirteen 1.0
 507  *
 508  * @return void
 509  */
 510 function twentythirteen_content_width() {
 511         global $content_width;
 512
 513         if ( is_attachment() )
 514                 $content_width = 724;
 515         elseif ( has_post_format( 'audio' ) )
 516                 $content_width = 484;
 517 }
 518 add_action( 'template_redirect', 'twentythirteen_content_width' );
 519
 520 /**
 521  * Add postMessage support for site title and description for the Customizer.
 522  *
 523  * @since Twenty Thirteen 1.0
 524  *
 525  * @param WP_Customize_Manager $wp_customize Customizer object.
 526  * @return void
 527  */
 528 function twentythirteen_customize_register( $wp_customize ) {
 529         $wp_customize->get_setting( 'blogname' )->transport         = 'postMessage';
 530         $wp_customize->get_setting( 'blogdescription' )->transport  = 'postMessage';
 531         $wp_customize->get_setting( 'header_textcolor' )->transport = 'postMessage';
 532 }
 533 add_action( 'customize_register', 'twentythirteen_customize_register' );
 534
 535 /**
 536  * Enqueue Javascript postMessage handlers for the Customizer.
 537  *
 538  * Binds JavaScript handlers to make the Customizer preview
 539  * reload changes asynchronously.
 540  *
 541  * @since Twenty Thirteen 1.0
 542  *
 543  * @return void
 544  */
 545 function twentythirteen_customize_preview_js() {
 546         wp_enqueue_script( 'twentythirteen-customizer', get_template_directory_uri() . '/js/theme-customizer.js', array( 'customize-preview' ), '20130226', true );
 547 }
 548 add_action( 'customize_preview_init', 'twentythirteen_customize_preview_js' );