WordPress.org

Make WordPress Core

Changeset 30569


Ignore:
Timestamp:
11/25/2014 08:56:33 PM (7 years ago)
Author:
iandstewart
Message:

Twenty Fifteen: docs correction and cleanup.

Props DrewAPicture, see #30149.

Location:
trunk/src/wp-content/themes/twentyfifteen
Files:
5 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-content/themes/twentyfifteen/functions.php

    r30568 r30569  
    148148 * @since Twenty Fifteen 1.0
    149149 *
    150  * @return string
     150 * @return string Google fonts URL for the theme.
    151151 */
    152152function twentyfifteen_fonts_url() {
     
    246246 *
    247247 * @since Twenty Fifteen 1.0
     248 *
     249 * @see wp_add_inline_style()
    248250 */
    249251function twentyfifteen_post_nav_background() {
     
    291293 * @param int     $depth       Depth of the menu.
    292294 * @param array   $args        wp_nav_menu() arguments.
    293  *
    294295 * @return string Menu item with possible description.
    295296 */
     
    308309 * @since Twenty Fifteen 1.0
    309310 *
    310  * @param string $html Search form HTML
    311  *
    312  * @return string Modified search form HTML
     311 * @param string $html Search form HTML.
     312 * @return string Modified search form HTML.
    313313 */
    314314function twentyfifteen_search_form_modify( $html ) {
  • trunk/src/wp-content/themes/twentyfifteen/inc/back-compat.php

    r30373 r30569  
    11<?php
    22/**
    3  * Twenty Fifteen back compat functionality.
     3 * Twenty Fifteen back compat functionality
    44 *
    55 * Prevents Twenty Fifteen from running on WordPress versions prior to 4.1,
    6  * since this theme is not meant to be backward compatible beyond that
    7  * and relies on many newer functions and markup changes introduced in 4.1.
     6 * since this theme is not meant to be backward compatible beyond that and
     7 * relies on many newer functions and markup changes introduced in 4.1.
    88 *
    99 * @package WordPress
  • trunk/src/wp-content/themes/twentyfifteen/inc/custom-header.php

    r30567 r30569  
    11<?php
    22/**
    3  * Implement Custom Header functionality for Twenty Fifteen.
     3 * Custom Header functionality for Twenty Fifteen
    44 *
    55 * @package WordPress
     
    4747 *
    4848 * @param string $color The original color, in 3- or 6-digit hexadecimal form.
    49  * @return array
     49 * @return array Array containing RGB (red, green, and blue) values for the given
     50 *               HEX code, empty array otherwise.
    5051 */
    5152function twentyfifteen_hex2rgb( $color ) {
     
    7273 *
    7374 * @since Twenty Fifteen 1.0
    74  * @see twentyfifteen_custom_header_setup().
     75 *
     76 * @see twentyfifteen_custom_header_setup()
    7577 */
    7678function twentyfifteen_header_style() {
     
    174176 *
    175177 * @since Twenty Fifteen 1.0
     178 *
     179 * @see wp_add_inline_style()
    176180 */
    177181function twentyfifteen_header_background_color_css() {
  • trunk/src/wp-content/themes/twentyfifteen/inc/customizer.php

    r30398 r30569  
    11<?php
    22/**
    3  * Twenty Fifteen Customizer.
     3 * Twenty Fifteen Customizer functionality
    44 *
    55 * @package WordPress
     
    7777/**
    7878 * Register color schemes for Twenty Fifteen.
    79  * Can be filtered with twentyfifteen_color_schemes.
     79 *
     80 * Can be filtered with {@see 'twentyfifteen_color_schemes'}.
    8081 *
    8182 * The order of colors in a colors array:
     
    164165if ( ! function_exists( 'twentyfifteen_get_color_scheme' ) ) :
    165166/**
    166  * Returns an array of either the current or default color scheme hex values.
    167  *
    168  * @since Twenty Fifteen 1.0
    169  *
    170  * @return array
     167 * Get the current Twenty Fifteen color scheme.
     168 *
     169 * @since Twenty Fifteen 1.0
     170 *
     171 * @return array An associative array of either the current or default color scheme hex values.
    171172 */
    172173function twentyfifteen_get_color_scheme() {
     
    188189 * @since Twenty Fifteen 1.0
    189190 *
    190  * @return array
     191 * @return array Array of color schemes.
    191192 */
    192193function twentyfifteen_get_color_scheme_choices() {
     
    209210 *
    210211 * @param string $value Color scheme name value.
    211  *
    212212 * @return string Color scheme name.
    213213 */
     
    227227 *
    228228 * @since Twenty Fifteen 1.0
     229 *
     230 * @see wp_add_inline_style()
    229231 */
    230232function twentyfifteen_color_scheme_css() {
     
    243245/**
    244246 * Binds JS listener to make Customizer color_scheme control.
     247 *
    245248 * Passes color scheme data as colorScheme global.
    246249 *
     
    266269 * Output an Underscore template for generating CSS for the color scheme.
    267270 *
    268  * The template generates the css dynamically for instant display in the Customizer preview,
    269  * and to be saved in a `theme_mod` for display on the front-end.
     271 * The template generates the css dynamically for instant display in the Customizer
     272 * preview, and to be saved in a `theme_mod` for display on the front-end.
    270273 *
    271274 * @since Twenty Fifteen 1.0
  • trunk/src/wp-content/themes/twentyfifteen/inc/template-tags.php

    r30372 r30569  
    11<?php
    22/**
    3  * Custom template tags for this theme.
     3 * Custom template tags for Twenty Fifteen
    44 *
    55 * Eventually, some of the functionality here could be replaced by core features.
     
    127127
    128128/**
    129  * Returns true if a blog has more than 1 category.
    130  *
    131  * @since Twenty Fifteen 1.0
    132  *
    133  * @return bool
     129 * Determine whether blog/site has more than one category.
     130 *
     131 * @since Twenty Fifteen 1.0
     132 *
     133 * @return bool True of there is more than one category, false otherwise.
    134134 */
    135135function twentyfifteen_categorized_blog() {
     
    160160
    161161/**
    162  * Flush out the transients used in twentyfifteen_categorized_blog.
     162 * Flush out the transients used in {@see twentyfifteen_categorized_blog()}.
    163163 *
    164164 * @since Twenty Fifteen 1.0
     
    211211 *
    212212 * @since Twenty Fifteen 1.0
    213  * @uses get_url_in_content()
     213 *
     214 * @see get_url_in_content()
    214215 *
    215216 * @return string The Link format URL.
     
    224225if ( ! function_exists( 'twentyfifteen_excerpt_more' ) && ! is_admin() ) :
    225226/**
    226  * Replaces "[...]" (appended to automatically generated excerpts) with ... and a Continue reading link.
    227  *
    228  * @since Twenty Fifteen 1.0
    229  *
     227 * Replaces "[...]" (appended to automatically generated excerpts) with ... and a 'Continue reading' link.
     228 *
     229 * @since Twenty Fifteen 1.0
     230 *
     231 * @return string 'Continue reading' link prepended with an ellipsis.
    230232 */
    231233function twentyfifteen_excerpt_more( $more ) {
Note: See TracChangeset for help on using the changeset viewer.