WordPress.org
Get WordPress

Make WordPress Core

Changeset 25521


Ignore:
Timestamp:
09/20/2013 07:23:22 PM (11 years ago)
Author:
lancewillett
Message:

Twenty Twelve: update code comments to reflect WP inline docs standards. Props DrewAPicture, see #25256.

Location:
trunk/src/wp-content/themes/twentytwelve
Files:
20 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-content/themes/twentytwelve/404.php

    r22318 r25521  
    11<?php
    22/**
    3  * The template for displaying 404 pages (Not Found).
     3 * The template for displaying 404 pages (Not Found)
    44 *
    55 * @package WordPress

  • trunk/src/wp-content/themes/twentytwelve/archive.php

    r22318 r25521  
    11<?php
    22/**
    3  * The template for displaying Archive pages.
     3 * The template for displaying Archive pages
    44 *
    55 * Used to display archive-type pages if nothing more specific matches a query.
    … …  
    1111 * author.php for Author archives.
    1212 *
    13  * Learn more: http://codex.wordpress.org/Template_Hierarchy
     13 * @link http://codex.wordpress.org/Template_Hierarchy
    1414 *
    1515 * @package WordPress

  • trunk/src/wp-content/themes/twentytwelve/author.php

    r22318 r25521  
    11<?php
    22/**
    3  * The template for displaying Author Archive pages.
     3 * The template for displaying Author Archive pages
    44 *
    55 * Used to display archive-type pages for posts by an author.
    66 *
    7  * Learn more: http://codex.wordpress.org/Template_Hierarchy
     7 * @link http://codex.wordpress.org/Template_Hierarchy
    88 *
    99 * @package WordPress
    … …  
    4848            <div class="author-info">
    4949                <div class="author-avatar">
    50                     <?php echo get_avatar( get_the_author_meta( 'user_email' ), apply_filters( 'twentytwelve_author_bio_avatar_size', 60 ) ); ?>
     50                    <?php
     51                    //duplicate_hook
     52                    $author_bio_avatar_size = apply_filters( 'twentytwelve_author_bio_avatar_size', 68 );
     53                    echo get_avatar( get_the_author_meta( 'user_email' ), $author_bio_avatar_size );
     54                    ?>
    5155                </div><!-- .author-avatar -->
    5256                <div class="author-description">

  • trunk/src/wp-content/themes/twentytwelve/category.php

    r22318 r25521  
    11<?php
    22/**
    3  * The template for displaying Category pages.
     3 * The template for displaying Category pages
    44 *
    55 * Used to display archive-type pages for posts in a category.
    66 *
    7  * Learn more: http://codex.wordpress.org/Template_Hierarchy
     7 * @link http://codex.wordpress.org/Template_Hierarchy
    88 *
    99 * @package WordPress

  • trunk/src/wp-content/themes/twentytwelve/comments.php

    r22620 r25521  
    11<?php
    22/**
    3  * The template for displaying Comments.
     3 * The template for displaying Comments
    44 *
    55 * The area of the page that contains both current comments
    … …  
    1313 */
    1414
    15 /*
     15/**
    1616 * If the current post is protected by a password and
    1717 * the visitor has not yet entered the password we will

  • trunk/src/wp-content/themes/twentytwelve/content-none.php

    r22318 r25521  
    11<?php
    22/**
    3  * The template for displaying a "No posts found" message.
     3 * The template for displaying a "No posts found" message
    44 *
    55 * @package WordPress

  • trunk/src/wp-content/themes/twentytwelve/content-status.php

    r22318 r25521  
    1515                <h2><a href="<?php the_permalink(); ?>" title="<?php echo esc_attr( sprintf( __( 'Permalink to %s', 'twentytwelve' ), the_title_attribute( 'echo=0' ) ) ); ?>" rel="bookmark"><?php echo get_the_date(); ?></a></h2>
    1616            </header>
    17             <?php echo get_avatar( get_the_author_meta( 'ID' ), apply_filters( 'twentytwelve_status_avatar', '48' ) ); ?>
     17            <?php
     18            /**
     19             * Filter the status avatar size.
     20             *
     21             * @since Twenty Twelve 1.0
     22             *
     23             * @param int $size The height and width of the avatar in pixels.
     24             */
     25            $status_avatar = apply_filters( 'twentytwelve_status_avatar', 48 );
     26            echo get_avatar( get_the_author_meta( 'ID' ), $status_avatar );
     27            ?>
    1828        </div><!-- .entry-header -->
    1929

  • trunk/src/wp-content/themes/twentytwelve/content.php

    r24131 r25521  
    11<?php
    22/**
    3  * The default template for displaying content. Used for both single and index/archive/search.
     3 * The default template for displaying content
     4 *
     5 * Used for both single and index/archive/search.
    46 *
    57 * @package WordPress
    … …  
    4850                <div class="author-info">
    4951                    <div class="author-avatar">
    50                         <?php echo get_avatar( get_the_author_meta( 'user_email' ), apply_filters( 'twentytwelve_author_bio_avatar_size', 68 ) ); ?>
     52                        <?php
     53                        /**
     54                         * Filter the author bio avatar size.
     55                         *
     56                         * @since Twenty Twelve 1.0
     57                         *
     58                         * @param int $size The height and width of the avatar in pixels.
     59                         */
     60                        $author_bio_avatar_size = apply_filters( 'twentytwelve_author_bio_avatar_size', 68 );
     61                        echo get_avatar( get_the_author_meta( 'user_email' ), $author_bio_avatar_size );
     62                        ?>
    5163                    </div><!-- .author-avatar -->
    5264                    <div class="author-description">

  • trunk/src/wp-content/themes/twentytwelve/footer.php

    r22318 r25521  
    11<?php
    22/**
    3  * The template for displaying the footer.
     3 * The template for displaying the footer
    44 *
    5  * Contains footer content and the closing of the
    6  * #main and #page div elements.
     5 * Contains footer content and the closing of the #main and #page div elements.
    76 *
    87 * @package WordPress

  • trunk/src/wp-content/themes/twentytwelve/functions.php

    r23716 r25521  
    11<?php
    22/**
    3  * Twenty Twelve functions and definitions.
     3 * Twenty Twelve functions and definitions
    44 *
    55 * Sets up the theme and provides some helper functions, which are used
    … …  
    1616 * to a filter or action hook.
    1717 *
    18  * For more information on hooks, actions, and filters, see http://codex.wordpress.org/Plugin_API.
     18 * For more information on hooks, actions, and filters, @link http://codex.wordpress.org/Plugin_API
    1919 *
    2020 * @package WordPress
    … …  
    2424
    2525/**
    26  * Sets up the content width value based on the theme's design and stylesheet.
     26 * Set up the content width value based on the theme's design and stylesheet.
    2727 */
    2828if ( ! isset( $content_width ) )
    … …  
    3030
    3131/**
     32 * Twenty Twelve setup.
     33 *
    3234 * Sets up theme defaults and registers the various WordPress features that
    3335 * Twenty Twelve supports.
    … …  
    4345 */
    4446function twentytwelve_setup() {
    45     /*
     47    /**
    4648     * Makes Twenty Twelve available for translation.
    4749     *
    … …  
    6466    register_nav_menu( 'primary', __( 'Primary Menu', 'twentytwelve' ) );
    6567
    66     /*
    67      * This theme supports custom background color and image, and here
    68      * we also set up the default background color.
     68    /**
     69     * This theme supports custom background color and image,
     70     * and here we also set up the default background color.
    6971     */
    7072    add_theme_support( 'custom-background', array(
    … …  
    7981
    8082/**
    81  * Adds support for a custom header image.
     83 * Add support for a custom header image.
    8284 */
    8385require( get_template_directory() . '/inc/custom-header.php' );
    8486
    8587/**
    86  * Returns the Google font stylesheet URL if available.
     88 * Return the Google font stylesheet URL if available.
    8789 *
    8890 * The use of Open Sans by default is localized. For languages that use
    … …  
    9698    $font_url = '';
    9799
    98     /* translators: If there are characters in your language that are not supported
    99      by Open Sans, translate this to 'off'. Do not translate into your own language. */
     100    /**
     101     * translators: If there are characters in your language that are not supported
     102     * by Open Sans, translate this to 'off'. Do not translate into your own language.
     103     */
    100104    if ( 'off' !== _x( 'on', 'Open Sans font: on or off', 'twentytwelve' ) ) {
    101105        $subsets = 'latin,latin-ext';
    102106
    103         /* translators: To add an additional Open Sans character subset specific to your language, translate
    104          this to 'greek', 'cyrillic' or 'vietnamese'. Do not translate into your own language. */
     107        /**
     108         * translators: To add an additional Open Sans character subset specific to your language,
     109         * translate this to 'greek', 'cyrillic' or 'vietnamese'. Do not translate into your own language.
     110         */
    105111        $subset = _x( 'no-subset', 'Open Sans font: add new subset (greek, cyrillic, vietnamese)', 'twentytwelve' );
    106112
    … …  
    124130
    125131/**
    126  * Enqueues scripts and styles for front-end.
    127  *
    128  * @since Twenty Twelve 1.0
     132 * Enqueue scripts and styles for front-end.
     133 *
     134 * @since Twenty Twelve 1.0
     135 *
     136 * @return void
    129137 */
    130138function twentytwelve_scripts_styles() {
    131139    global $wp_styles;
    132140
    133     /*
     141    /**
    134142     * Adds JavaScript to pages with the comment form to support
    135143     * sites with threaded comments (when in use).
    … …  
    138146        wp_enqueue_script( 'comment-reply' );
    139147
    140     /*
     148    /**
    141149     * Adds JavaScript for handling the navigation menu hide-and-show behavior.
    142150     */
    … …  
    147155        wp_enqueue_style( 'twentytwelve-fonts', esc_url_raw( $font_url ), array(), null );
    148156
    149     /*
     157    /**
    150158     * Loads our main stylesheet.
    151159     */
    152160    wp_enqueue_style( 'twentytwelve-style', get_stylesheet_uri() );
    153161
    154     /*
     162    /**
    155163     * Loads the Internet Explorer specific stylesheet.
    156164     */
    … …  
    161169
    162170/**
     171 * Filter TinyMCE CSS path to include Google Fonts.
     172 *
    163173 * Adds additional stylesheets to the TinyMCE editor if needed.
    164174 *
    … …  
    168178 *
    169179 * @param string $mce_css CSS path to load in TinyMCE.
    170  * @return string
     180 * @return string Filtered CSS path.
    171181 */
    172182function twentytwelve_mce_css( $mce_css ) {
    … …  
    186196
    187197/**
     198 * Filter the page title.
     199 *
    188200 * Creates a nicely formatted and more specific title element text
    189201 * for output in head of document, based on current view.
    … …  
    218230
    219231/**
     232 * Filter the page menu arguments.
     233 *
    220234 * Makes our wp_nav_menu() fallback -- wp_page_menu() -- show a home link.
    221235 *
    … …  
    230244
    231245/**
     246 * Register sidebars.
     247 *
    232248 * Registers our main widget area and the front page widget areas.
    233249 *
    … …  
    298314 *
    299315 * @since Twenty Twelve 1.0
     316 *
     317 * @return void
    300318 */
    301319function twentytwelve_comment( $comment, $args, $depth ) {
    … …  
    354372if ( ! function_exists( 'twentytwelve_entry_meta' ) ) :
    355373/**
     374 * Set up post entry meta.
     375 *
    356376 * Prints HTML with meta information for current post: categories, tags, permalink, author, and date.
    357377 *
    … …  
    359379 *
    360380 * @since Twenty Twelve 1.0
     381 *
     382 * @return void
    361383 */
    362384function twentytwelve_entry_meta() {
    … …  
    400422
    401423/**
     424 * Extend the default WordPress body classes.
     425 *
    402426 * Extends the default WordPress body class to denote:
    403427 * 1. Using a full-width layout, when no active widgets in the sidebar
    … …  
    411435 * @since Twenty Twelve 1.0
    412436 *
    413  * @param array Existing class values.
     437 * @param array $classes Existing class values.
    414438 * @return array Filtered class values.
    415439 */
    … …  
    448472
    449473/**
     474 * Adjust content width in certain contexts.
     475 *
    450476 * Adjusts content_width value for full-width and single image attachment
    451477 * templates, and when there are no active widgets in the sidebar.
    452478 *
    453479 * @since Twenty Twelve 1.0
     480 *
     481 * @return void
    454482 */
    455483function twentytwelve_content_width() {
    … …  
    462490
    463491/**
    464  * Add postMessage support for site title and description for the Theme Customizer.
    465  *
    466  * @since Twenty Twelve 1.0
    467  *
    468  * @param WP_Customize_Manager $wp_customize Theme Customizer object.
     492 * Register postMessage support.
     493 *
     494 * Add postMessage support for site title and description for the Customizer.
     495 *
     496 * @since Twenty Twelve 1.0
     497 *
     498 * @param WP_Customize_Manager $wp_customize Customizer object.
    469499 * @return void
    470500 */
    … …  
    477507
    478508/**
    479  * Binds JS handlers to make Theme Customizer preview reload changes asynchronously.
    480  *
    481  * @since Twenty Twelve 1.0
     509 * Enqueue Javascript postMessage handlers for the Customizer.
     510 *
     511 * Binds JS handlers to make the Customizer preview reload changes asynchronously.
     512 *
     513 * @since Twenty Twelve 1.0
     514 *
     515 * @return void
    482516 */
    483517function twentytwelve_customize_preview_js() {

  • trunk/src/wp-content/themes/twentytwelve/header.php

    r22318 r25521  
    11<?php
    22/**
    3  * The Header for our theme.
     3 * The Header template for our theme
    44 *
    55 * Displays all of the <head> section and everything up till <div id="main">

  • trunk/src/wp-content/themes/twentytwelve/image.php

    r22318 r25521  
    11<?php
    22/**
    3  * The template for displaying image attachments.
     3 * The template for displaying image attachments
    44 *
    5  * Learn more: http://codex.wordpress.org/Template_Hierarchy
     5 * @link http://codex.wordpress.org/Template_Hierarchy
    66 *
    77 * @package WordPress
    … …  
    7575?>
    7676                                <a href="<?php echo esc_url( $next_attachment_url ); ?>" title="<?php the_title_attribute(); ?>" rel="attachment"><?php
     77                                /**
     78                                 * Filter the image attachment size to use.
     79                                 *
     80                                 * @since Twenty Twelve 1.0
     81                                 *
     82                                 * @param array $size {
     83                                 *     @type int The attachment height in pixels.
     84                                 *     @type int The attachment width in pixels.
     85                                 * }
     86                                 */
    7787                                $attachment_size = apply_filters( 'twentytwelve_attachment_size', array( 960, 960 ) );
    7888                                echo wp_get_attachment_image( $post->ID, $attachment_size );

  • trunk/src/wp-content/themes/twentytwelve/inc/custom-header.php

    r24050 r25521  
    11<?php
    22/**
    3  * Implements an optional custom header for Twenty Twelve.
     3 * Implement an optional custom header for Twenty Twelve
     4 *
    45 * See http://codex.wordpress.org/Custom_Headers
    56 *
    … …  
    1011
    1112/**
    12  * Sets up the WordPress core custom header arguments and settings.
     13 * Set up the WordPress core custom header arguments and settings.
    1314 *
    1415 * @uses add_theme_support() to register support for 3.4 and up.
    … …  
    4849
    4950/**
    50  * Loads our special font CSS file.
     51 * Load our special font CSS file.
    5152 *
    5253 * @since Twenty Twelve 1.2
    … …  
    6263
    6364/**
    64  * Styles the header text displayed on the blog.
     65 * Style the header text displayed on the blog.
    6566 *
    6667 * get_header_textcolor() options: 515151 is default, hide text (returns 'blank'), or any hex value.
    … …  
    102103
    103104/**
    104  * Styles the header image displayed on the Appearance > Header admin panel.
     105 * Style the header image displayed on the Appearance > Header admin panel.
    105106 *
    106107 * @since Twenty Twelve 1.0
    … …  
    142143
    143144/**
    144  * Outputs markup to be displayed on the Appearance > Header admin panel.
     145 * Output markup to be displayed on the Appearance > Header admin panel.
     146 *
    145147 * This callback overrides the default markup displayed there.
    146148 *

  • trunk/src/wp-content/themes/twentytwelve/index.php

    r22318 r25521  
    11<?php
    22/**
    3  * The main template file.
     3 * The main template file
    44 *
    55 * This is the most generic template file in a WordPress theme
    … …  
    88 * For example, it puts together the home page when no home.php file exists.
    99 *
    10  * Learn more: http://codex.wordpress.org/Template_Hierarchy
     10 * @link http://codex.wordpress.org/Template_Hierarchy
    1111 *
    1212 * @package WordPress

  • trunk/src/wp-content/themes/twentytwelve/page.php

    r22318 r25521  
    11<?php
    22/**
    3  * The template for displaying all pages.
     3 * The template for displaying all pages
    44 *
    55 * This is the template that displays all pages by default.

  • trunk/src/wp-content/themes/twentytwelve/search.php

    r22318 r25521  
    11<?php
    22/**
    3  * The template for displaying Search Results pages.
     3 * The template for displaying Search Results pages
    44 *
    55 * @package WordPress

  • trunk/src/wp-content/themes/twentytwelve/sidebar-front.php

    r22318 r25521  
    11<?php
    22/**
    3  * The sidebar containing the front page widget areas.
     3 * The sidebar containing the front page widget areas
    44 *
    5  * If no active widgets in either sidebar, they will be hidden completely.
     5 * If no active widgets are in either sidebar, hide them completely.
    66 *
    77 * @package WordPress
    … …  
    1010 */
    1111
    12 /*
     12/**
    1313 * The front page widget area is triggered if any of the areas
    1414 * have widgets. So let's check that first.

  • trunk/src/wp-content/themes/twentytwelve/sidebar.php

    r22318 r25521  
    11<?php
    22/**
    3  * The sidebar containing the main widget area.
     3 * The sidebar containing the main widget area
    44 *
    5  * If no active widgets in sidebar, let's hide it completely.
     5 * If no active widgets are in the sidebar, hide it completely.
    66 *
    77 * @package WordPress

  • trunk/src/wp-content/themes/twentytwelve/single.php

    r22615 r25521  
    11<?php
    22/**
    3  * The Template for displaying all single posts.
     3 * The Template for displaying all single posts
    44 *
    55 * @package WordPress

  • trunk/src/wp-content/themes/twentytwelve/tag.php

    r22318 r25521  
    11<?php
    22/**
    3  * The template for displaying Tag pages.
     3 * The template for displaying Tag pages
    44 *
    55 * Used to display archive-type pages for posts in a tag.
    66 *
    7  * Learn more: http://codex.wordpress.org/Template_Hierarchy
     7 * @link http://codex.wordpress.org/Template_Hierarchy
    88 *
    99 * @package WordPress
    … …  
    3030            while ( have_posts() ) : the_post();
    3131
    32                 /* Include the post format-specific template for the content. If you want to
     32                /**
     33                 * Include the post format-specific template for the content. If you want to
    3334                 * this in a child theme then include a file called called content-___.php
    3435                 * (where ___ is the post format) and that will be used instead.
Note: See TracChangeset for help on using the changeset viewer.