wp/wp-content/themes/twentyfourteen/functions.php
changeset 5 5e2f62d02dcd
child 7 cf61fcea0001
equal deleted inserted replaced
4:346c88efed21 5:5e2f62d02dcd
       
     1 <?php
       
     2 /**
       
     3  * Twenty Fourteen functions and definitions
       
     4  *
       
     5  * Set 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 you can override certain functions (those wrapped
       
    10  * in a function_exists() call) by defining them first in your child theme's
       
    11  * functions.php file. The child theme's functions.php file is included before
       
    12  * the parent theme's file, so the child theme functions would be used.
       
    13  *
       
    14  * @link https://codex.wordpress.org/Theme_Development
       
    15  * @link https://codex.wordpress.org/Child_Themes
       
    16  *
       
    17  * Functions that are not pluggable (not wrapped in function_exists()) are
       
    18  * instead attached to a filter or action hook.
       
    19  *
       
    20  * For more information on hooks, actions, and filters,
       
    21  * @link https://codex.wordpress.org/Plugin_API
       
    22  *
       
    23  * @package WordPress
       
    24  * @subpackage Twenty_Fourteen
       
    25  * @since Twenty Fourteen 1.0
       
    26  */
       
    27 
       
    28 /**
       
    29  * Set up the content width value based on the theme's design.
       
    30  *
       
    31  * @see twentyfourteen_content_width()
       
    32  *
       
    33  * @since Twenty Fourteen 1.0
       
    34  */
       
    35 if ( ! isset( $content_width ) ) {
       
    36 	$content_width = 474;
       
    37 }
       
    38 
       
    39 /**
       
    40  * Twenty Fourteen only works in WordPress 3.6 or later.
       
    41  */
       
    42 if ( version_compare( $GLOBALS['wp_version'], '3.6', '<' ) ) {
       
    43 	require get_template_directory() . '/inc/back-compat.php';
       
    44 }
       
    45 
       
    46 if ( ! function_exists( 'twentyfourteen_setup' ) ) :
       
    47 /**
       
    48  * Twenty Fourteen setup.
       
    49  *
       
    50  * Set up theme defaults and registers support for various WordPress features.
       
    51  *
       
    52  * Note that this function is hooked into the after_setup_theme hook, which
       
    53  * runs before the init hook. The init hook is too late for some features, such
       
    54  * as indicating support post thumbnails.
       
    55  *
       
    56  * @since Twenty Fourteen 1.0
       
    57  */
       
    58 function twentyfourteen_setup() {
       
    59 
       
    60 	/*
       
    61 	 * Make Twenty Fourteen available for translation.
       
    62 	 *
       
    63 	 * Translations can be added to the /languages/ directory.
       
    64 	 * If you're building a theme based on Twenty Fourteen, use a find and
       
    65 	 * replace to change 'twentyfourteen' to the name of your theme in all
       
    66 	 * template files.
       
    67 	 */
       
    68 	load_theme_textdomain( 'twentyfourteen', get_template_directory() . '/languages' );
       
    69 
       
    70 	// This theme styles the visual editor to resemble the theme style.
       
    71 	add_editor_style( array( 'css/editor-style.css', twentyfourteen_font_url(), 'genericons/genericons.css' ) );
       
    72 
       
    73 	// Add RSS feed links to <head> for posts and comments.
       
    74 	add_theme_support( 'automatic-feed-links' );
       
    75 
       
    76 	// Enable support for Post Thumbnails, and declare two sizes.
       
    77 	add_theme_support( 'post-thumbnails' );
       
    78 	set_post_thumbnail_size( 672, 372, true );
       
    79 	add_image_size( 'twentyfourteen-full-width', 1038, 576, true );
       
    80 
       
    81 	// This theme uses wp_nav_menu() in two locations.
       
    82 	register_nav_menus( array(
       
    83 		'primary'   => __( 'Top primary menu', 'twentyfourteen' ),
       
    84 		'secondary' => __( 'Secondary menu in left sidebar', 'twentyfourteen' ),
       
    85 	) );
       
    86 
       
    87 	/*
       
    88 	 * Switch default core markup for search form, comment form, and comments
       
    89 	 * to output valid HTML5.
       
    90 	 */
       
    91 	add_theme_support( 'html5', array(
       
    92 		'search-form', 'comment-form', 'comment-list', 'gallery', 'caption'
       
    93 	) );
       
    94 
       
    95 	/*
       
    96 	 * Enable support for Post Formats.
       
    97 	 * See https://codex.wordpress.org/Post_Formats
       
    98 	 */
       
    99 	add_theme_support( 'post-formats', array(
       
   100 		'aside', 'image', 'video', 'audio', 'quote', 'link', 'gallery',
       
   101 	) );
       
   102 
       
   103 	// This theme allows users to set a custom background.
       
   104 	add_theme_support( 'custom-background', apply_filters( 'twentyfourteen_custom_background_args', array(
       
   105 		'default-color' => 'f5f5f5',
       
   106 	) ) );
       
   107 
       
   108 	// Add support for featured content.
       
   109 	add_theme_support( 'featured-content', array(
       
   110 		'featured_content_filter' => 'twentyfourteen_get_featured_posts',
       
   111 		'max_posts' => 6,
       
   112 	) );
       
   113 
       
   114 	// This theme uses its own gallery styles.
       
   115 	add_filter( 'use_default_gallery_style', '__return_false' );
       
   116 }
       
   117 endif; // twentyfourteen_setup
       
   118 add_action( 'after_setup_theme', 'twentyfourteen_setup' );
       
   119 
       
   120 /**
       
   121  * Adjust content_width value for image attachment template.
       
   122  *
       
   123  * @since Twenty Fourteen 1.0
       
   124  */
       
   125 function twentyfourteen_content_width() {
       
   126 	if ( is_attachment() && wp_attachment_is_image() ) {
       
   127 		$GLOBALS['content_width'] = 810;
       
   128 	}
       
   129 }
       
   130 add_action( 'template_redirect', 'twentyfourteen_content_width' );
       
   131 
       
   132 /**
       
   133  * Getter function for Featured Content Plugin.
       
   134  *
       
   135  * @since Twenty Fourteen 1.0
       
   136  *
       
   137  * @return array An array of WP_Post objects.
       
   138  */
       
   139 function twentyfourteen_get_featured_posts() {
       
   140 	/**
       
   141 	 * Filter the featured posts to return in Twenty Fourteen.
       
   142 	 *
       
   143 	 * @since Twenty Fourteen 1.0
       
   144 	 *
       
   145 	 * @param array|bool $posts Array of featured posts, otherwise false.
       
   146 	 */
       
   147 	return apply_filters( 'twentyfourteen_get_featured_posts', array() );
       
   148 }
       
   149 
       
   150 /**
       
   151  * A helper conditional function that returns a boolean value.
       
   152  *
       
   153  * @since Twenty Fourteen 1.0
       
   154  *
       
   155  * @return bool Whether there are featured posts.
       
   156  */
       
   157 function twentyfourteen_has_featured_posts() {
       
   158 	return ! is_paged() && (bool) twentyfourteen_get_featured_posts();
       
   159 }
       
   160 
       
   161 /**
       
   162  * Register three Twenty Fourteen widget areas.
       
   163  *
       
   164  * @since Twenty Fourteen 1.0
       
   165  */
       
   166 function twentyfourteen_widgets_init() {
       
   167 	require get_template_directory() . '/inc/widgets.php';
       
   168 	register_widget( 'Twenty_Fourteen_Ephemera_Widget' );
       
   169 
       
   170 	register_sidebar( array(
       
   171 		'name'          => __( 'Primary Sidebar', 'twentyfourteen' ),
       
   172 		'id'            => 'sidebar-1',
       
   173 		'description'   => __( 'Main sidebar that appears on the left.', 'twentyfourteen' ),
       
   174 		'before_widget' => '<aside id="%1$s" class="widget %2$s">',
       
   175 		'after_widget'  => '</aside>',
       
   176 		'before_title'  => '<h1 class="widget-title">',
       
   177 		'after_title'   => '</h1>',
       
   178 	) );
       
   179 	register_sidebar( array(
       
   180 		'name'          => __( 'Content Sidebar', 'twentyfourteen' ),
       
   181 		'id'            => 'sidebar-2',
       
   182 		'description'   => __( 'Additional sidebar that appears on the right.', 'twentyfourteen' ),
       
   183 		'before_widget' => '<aside id="%1$s" class="widget %2$s">',
       
   184 		'after_widget'  => '</aside>',
       
   185 		'before_title'  => '<h1 class="widget-title">',
       
   186 		'after_title'   => '</h1>',
       
   187 	) );
       
   188 	register_sidebar( array(
       
   189 		'name'          => __( 'Footer Widget Area', 'twentyfourteen' ),
       
   190 		'id'            => 'sidebar-3',
       
   191 		'description'   => __( 'Appears in the footer section of the site.', 'twentyfourteen' ),
       
   192 		'before_widget' => '<aside id="%1$s" class="widget %2$s">',
       
   193 		'after_widget'  => '</aside>',
       
   194 		'before_title'  => '<h1 class="widget-title">',
       
   195 		'after_title'   => '</h1>',
       
   196 	) );
       
   197 }
       
   198 add_action( 'widgets_init', 'twentyfourteen_widgets_init' );
       
   199 
       
   200 /**
       
   201  * Register Lato Google font for Twenty Fourteen.
       
   202  *
       
   203  * @since Twenty Fourteen 1.0
       
   204  *
       
   205  * @return string
       
   206  */
       
   207 function twentyfourteen_font_url() {
       
   208 	$font_url = '';
       
   209 	/*
       
   210 	 * Translators: If there are characters in your language that are not supported
       
   211 	 * by Lato, translate this to 'off'. Do not translate into your own language.
       
   212 	 */
       
   213 	if ( 'off' !== _x( 'on', 'Lato font: on or off', 'twentyfourteen' ) ) {
       
   214 		$query_args = array(
       
   215 			'family' => urlencode( 'Lato:300,400,700,900,300italic,400italic,700italic' ),
       
   216 			'subset' => urlencode( 'latin,latin-ext' ),
       
   217 		);
       
   218 		$font_url = add_query_arg( $query_args, '//fonts.googleapis.com/css' );
       
   219 	}
       
   220 
       
   221 	return $font_url;
       
   222 }
       
   223 
       
   224 /**
       
   225  * Enqueue scripts and styles for the front end.
       
   226  *
       
   227  * @since Twenty Fourteen 1.0
       
   228  */
       
   229 function twentyfourteen_scripts() {
       
   230 	// Add Lato font, used in the main stylesheet.
       
   231 	wp_enqueue_style( 'twentyfourteen-lato', twentyfourteen_font_url(), array(), null );
       
   232 
       
   233 	// Add Genericons font, used in the main stylesheet.
       
   234 	wp_enqueue_style( 'genericons', get_template_directory_uri() . '/genericons/genericons.css', array(), '3.0.3' );
       
   235 
       
   236 	// Load our main stylesheet.
       
   237 	wp_enqueue_style( 'twentyfourteen-style', get_stylesheet_uri() );
       
   238 
       
   239 	// Load the Internet Explorer specific stylesheet.
       
   240 	wp_enqueue_style( 'twentyfourteen-ie', get_template_directory_uri() . '/css/ie.css', array( 'twentyfourteen-style' ), '20131205' );
       
   241 	wp_style_add_data( 'twentyfourteen-ie', 'conditional', 'lt IE 9' );
       
   242 
       
   243 	if ( is_singular() && comments_open() && get_option( 'thread_comments' ) ) {
       
   244 		wp_enqueue_script( 'comment-reply' );
       
   245 	}
       
   246 
       
   247 	if ( is_singular() && wp_attachment_is_image() ) {
       
   248 		wp_enqueue_script( 'twentyfourteen-keyboard-image-navigation', get_template_directory_uri() . '/js/keyboard-image-navigation.js', array( 'jquery' ), '20130402' );
       
   249 	}
       
   250 
       
   251 	if ( is_active_sidebar( 'sidebar-3' ) ) {
       
   252 		wp_enqueue_script( 'jquery-masonry' );
       
   253 	}
       
   254 
       
   255 	if ( is_front_page() && 'slider' == get_theme_mod( 'featured_content_layout' ) ) {
       
   256 		wp_enqueue_script( 'twentyfourteen-slider', get_template_directory_uri() . '/js/slider.js', array( 'jquery' ), '20131205', true );
       
   257 		wp_localize_script( 'twentyfourteen-slider', 'featuredSliderDefaults', array(
       
   258 			'prevText' => __( 'Previous', 'twentyfourteen' ),
       
   259 			'nextText' => __( 'Next', 'twentyfourteen' )
       
   260 		) );
       
   261 	}
       
   262 
       
   263 	wp_enqueue_script( 'twentyfourteen-script', get_template_directory_uri() . '/js/functions.js', array( 'jquery' ), '20150315', true );
       
   264 }
       
   265 add_action( 'wp_enqueue_scripts', 'twentyfourteen_scripts' );
       
   266 
       
   267 /**
       
   268  * Enqueue Google fonts style to admin screen for custom header display.
       
   269  *
       
   270  * @since Twenty Fourteen 1.0
       
   271  */
       
   272 function twentyfourteen_admin_fonts() {
       
   273 	wp_enqueue_style( 'twentyfourteen-lato', twentyfourteen_font_url(), array(), null );
       
   274 }
       
   275 add_action( 'admin_print_scripts-appearance_page_custom-header', 'twentyfourteen_admin_fonts' );
       
   276 
       
   277 if ( ! function_exists( 'twentyfourteen_the_attached_image' ) ) :
       
   278 /**
       
   279  * Print the attached image with a link to the next attached image.
       
   280  *
       
   281  * @since Twenty Fourteen 1.0
       
   282  */
       
   283 function twentyfourteen_the_attached_image() {
       
   284 	$post                = get_post();
       
   285 	/**
       
   286 	 * Filter the default Twenty Fourteen attachment size.
       
   287 	 *
       
   288 	 * @since Twenty Fourteen 1.0
       
   289 	 *
       
   290 	 * @param array $dimensions {
       
   291 	 *     An array of height and width dimensions.
       
   292 	 *
       
   293 	 *     @type int $height Height of the image in pixels. Default 810.
       
   294 	 *     @type int $width  Width of the image in pixels. Default 810.
       
   295 	 * }
       
   296 	 */
       
   297 	$attachment_size     = apply_filters( 'twentyfourteen_attachment_size', array( 810, 810 ) );
       
   298 	$next_attachment_url = wp_get_attachment_url();
       
   299 
       
   300 	/*
       
   301 	 * Grab the IDs of all the image attachments in a gallery so we can get the URL
       
   302 	 * of the next adjacent image in a gallery, or the first image (if we're
       
   303 	 * looking at the last image in a gallery), or, in a gallery of one, just the
       
   304 	 * link to that image file.
       
   305 	 */
       
   306 	$attachment_ids = get_posts( array(
       
   307 		'post_parent'    => $post->post_parent,
       
   308 		'fields'         => 'ids',
       
   309 		'numberposts'    => -1,
       
   310 		'post_status'    => 'inherit',
       
   311 		'post_type'      => 'attachment',
       
   312 		'post_mime_type' => 'image',
       
   313 		'order'          => 'ASC',
       
   314 		'orderby'        => 'menu_order ID',
       
   315 	) );
       
   316 
       
   317 	// If there is more than 1 attachment in a gallery...
       
   318 	if ( count( $attachment_ids ) > 1 ) {
       
   319 		foreach ( $attachment_ids as $attachment_id ) {
       
   320 			if ( $attachment_id == $post->ID ) {
       
   321 				$next_id = current( $attachment_ids );
       
   322 				break;
       
   323 			}
       
   324 		}
       
   325 
       
   326 		// get the URL of the next image attachment...
       
   327 		if ( $next_id ) {
       
   328 			$next_attachment_url = get_attachment_link( $next_id );
       
   329 		}
       
   330 
       
   331 		// or get the URL of the first image attachment.
       
   332 		else {
       
   333 			$next_attachment_url = get_attachment_link( reset( $attachment_ids ) );
       
   334 		}
       
   335 	}
       
   336 
       
   337 	printf( '<a href="%1$s" rel="attachment">%2$s</a>',
       
   338 		esc_url( $next_attachment_url ),
       
   339 		wp_get_attachment_image( $post->ID, $attachment_size )
       
   340 	);
       
   341 }
       
   342 endif;
       
   343 
       
   344 if ( ! function_exists( 'twentyfourteen_list_authors' ) ) :
       
   345 /**
       
   346  * Print a list of all site contributors who published at least one post.
       
   347  *
       
   348  * @since Twenty Fourteen 1.0
       
   349  */
       
   350 function twentyfourteen_list_authors() {
       
   351 	$contributor_ids = get_users( array(
       
   352 		'fields'  => 'ID',
       
   353 		'orderby' => 'post_count',
       
   354 		'order'   => 'DESC',
       
   355 		'who'     => 'authors',
       
   356 	) );
       
   357 
       
   358 	foreach ( $contributor_ids as $contributor_id ) :
       
   359 		$post_count = count_user_posts( $contributor_id );
       
   360 
       
   361 		// Move on if user has not published a post (yet).
       
   362 		if ( ! $post_count ) {
       
   363 			continue;
       
   364 		}
       
   365 	?>
       
   366 
       
   367 	<div class="contributor">
       
   368 		<div class="contributor-info">
       
   369 			<div class="contributor-avatar"><?php echo get_avatar( $contributor_id, 132 ); ?></div>
       
   370 			<div class="contributor-summary">
       
   371 				<h2 class="contributor-name"><?php echo get_the_author_meta( 'display_name', $contributor_id ); ?></h2>
       
   372 				<p class="contributor-bio">
       
   373 					<?php echo get_the_author_meta( 'description', $contributor_id ); ?>
       
   374 				</p>
       
   375 				<a class="button contributor-posts-link" href="<?php echo esc_url( get_author_posts_url( $contributor_id ) ); ?>">
       
   376 					<?php printf( _n( '%d Article', '%d Articles', $post_count, 'twentyfourteen' ), $post_count ); ?>
       
   377 				</a>
       
   378 			</div><!-- .contributor-summary -->
       
   379 		</div><!-- .contributor-info -->
       
   380 	</div><!-- .contributor -->
       
   381 
       
   382 	<?php
       
   383 	endforeach;
       
   384 }
       
   385 endif;
       
   386 
       
   387 /**
       
   388  * Extend the default WordPress body classes.
       
   389  *
       
   390  * Adds body classes to denote:
       
   391  * 1. Single or multiple authors.
       
   392  * 2. Presence of header image except in Multisite signup and activate pages.
       
   393  * 3. Index views.
       
   394  * 4. Full-width content layout.
       
   395  * 5. Presence of footer widgets.
       
   396  * 6. Single views.
       
   397  * 7. Featured content layout.
       
   398  *
       
   399  * @since Twenty Fourteen 1.0
       
   400  *
       
   401  * @param array $classes A list of existing body class values.
       
   402  * @return array The filtered body class list.
       
   403  */
       
   404 function twentyfourteen_body_classes( $classes ) {
       
   405 	if ( is_multi_author() ) {
       
   406 		$classes[] = 'group-blog';
       
   407 	}
       
   408 
       
   409 	if ( get_header_image() ) {
       
   410 		$classes[] = 'header-image';
       
   411 	} elseif ( ! in_array( $GLOBALS['pagenow'], array( 'wp-activate.php', 'wp-signup.php' ) ) ) {
       
   412 		$classes[] = 'masthead-fixed';
       
   413 	}
       
   414 
       
   415 	if ( is_archive() || is_search() || is_home() ) {
       
   416 		$classes[] = 'list-view';
       
   417 	}
       
   418 
       
   419 	if ( ( ! is_active_sidebar( 'sidebar-2' ) )
       
   420 		|| is_page_template( 'page-templates/full-width.php' )
       
   421 		|| is_page_template( 'page-templates/contributors.php' )
       
   422 		|| is_attachment() ) {
       
   423 		$classes[] = 'full-width';
       
   424 	}
       
   425 
       
   426 	if ( is_active_sidebar( 'sidebar-3' ) ) {
       
   427 		$classes[] = 'footer-widgets';
       
   428 	}
       
   429 
       
   430 	if ( is_singular() && ! is_front_page() ) {
       
   431 		$classes[] = 'singular';
       
   432 	}
       
   433 
       
   434 	if ( is_front_page() && 'slider' == get_theme_mod( 'featured_content_layout' ) ) {
       
   435 		$classes[] = 'slider';
       
   436 	} elseif ( is_front_page() ) {
       
   437 		$classes[] = 'grid';
       
   438 	}
       
   439 
       
   440 	return $classes;
       
   441 }
       
   442 add_filter( 'body_class', 'twentyfourteen_body_classes' );
       
   443 
       
   444 /**
       
   445  * Extend the default WordPress post classes.
       
   446  *
       
   447  * Adds a post class to denote:
       
   448  * Non-password protected page with a post thumbnail.
       
   449  *
       
   450  * @since Twenty Fourteen 1.0
       
   451  *
       
   452  * @param array $classes A list of existing post class values.
       
   453  * @return array The filtered post class list.
       
   454  */
       
   455 function twentyfourteen_post_classes( $classes ) {
       
   456 	if ( ! post_password_required() && ! is_attachment() && has_post_thumbnail() ) {
       
   457 		$classes[] = 'has-post-thumbnail';
       
   458 	}
       
   459 
       
   460 	return $classes;
       
   461 }
       
   462 add_filter( 'post_class', 'twentyfourteen_post_classes' );
       
   463 
       
   464 /**
       
   465  * Create a nicely formatted and more specific title element text for output
       
   466  * in head of document, based on current view.
       
   467  *
       
   468  * @since Twenty Fourteen 1.0
       
   469  *
       
   470  * @global int $paged WordPress archive pagination page count.
       
   471  * @global int $page  WordPress paginated post page count.
       
   472  *
       
   473  * @param string $title Default title text for current view.
       
   474  * @param string $sep Optional separator.
       
   475  * @return string The filtered title.
       
   476  */
       
   477 function twentyfourteen_wp_title( $title, $sep ) {
       
   478 	global $paged, $page;
       
   479 
       
   480 	if ( is_feed() ) {
       
   481 		return $title;
       
   482 	}
       
   483 
       
   484 	// Add the site name.
       
   485 	$title .= get_bloginfo( 'name', 'display' );
       
   486 
       
   487 	// Add the site description for the home/front page.
       
   488 	$site_description = get_bloginfo( 'description', 'display' );
       
   489 	if ( $site_description && ( is_home() || is_front_page() ) ) {
       
   490 		$title = "$title $sep $site_description";
       
   491 	}
       
   492 
       
   493 	// Add a page number if necessary.
       
   494 	if ( ( $paged >= 2 || $page >= 2 ) && ! is_404() ) {
       
   495 		$title = "$title $sep " . sprintf( __( 'Page %s', 'twentyfourteen' ), max( $paged, $page ) );
       
   496 	}
       
   497 
       
   498 	return $title;
       
   499 }
       
   500 add_filter( 'wp_title', 'twentyfourteen_wp_title', 10, 2 );
       
   501 
       
   502 // Implement Custom Header features.
       
   503 require get_template_directory() . '/inc/custom-header.php';
       
   504 
       
   505 // Custom template tags for this theme.
       
   506 require get_template_directory() . '/inc/template-tags.php';
       
   507 
       
   508 // Add Customizer functionality.
       
   509 require get_template_directory() . '/inc/customizer.php';
       
   510 
       
   511 /*
       
   512  * Add Featured Content functionality.
       
   513  *
       
   514  * To overwrite in a plugin, define your own Featured_Content class on or
       
   515  * before the 'setup_theme' hook.
       
   516  */
       
   517 if ( ! class_exists( 'Featured_Content' ) && 'plugins.php' !== $GLOBALS['pagenow'] ) {
       
   518 	require get_template_directory() . '/inc/featured-content.php';
       
   519 }