WordPress.org
Get WordPress

Make WordPress Core

Changeset 56121


Ignore:
Timestamp:
07/01/2023 05:02:18 PM (19 months ago)
Author:
audrasjb
Message:

Twenty Seventeen: Various docblock fixes.

Props sabernhardt, audrasjb.
Fixes #58695.
See #57840.

Location:
trunk/src/wp-content/themes/twentyseventeen/inc
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-content/themes/twentyseventeen/inc/template-functions.php

    r48782 r56121  
    11<?php
    22/**
    3  * Additional features to allow styling of the templates
     3 * Additional features to allow styling of the templates.
    44 *
    55 * @package WordPress
    … …  
    6868
    6969/**
    70  * Count our number of active panels.
     70 * Counts the number of our active panels.
    7171 *
    72  * Primarily used to see if we have any panels active, duh.
     72 * Primarily used to see if we have any panels active.
     73 *
     74 * @return int The number of active panels.
    7375 */
    7476function twentyseventeen_panel_count() {
    … …  
    9698
    9799/**
    98  * Checks to see if we're on the front page or not.
     100 * Checks to see if we are on the front page or not.
     101 *
     102 * @return bool Whether we are on the front page or not.
    99103 */
    100104function twentyseventeen_is_frontpage() {

  • trunk/src/wp-content/themes/twentyseventeen/inc/template-tags.php

    r55276 r56121  
    11<?php
    22/**
    3  * Custom template tags for this theme
     3 * Custom template tags for this theme.
    44 *
    55 * Eventually, some of the functionality here could be replaced by core features.
    … …  
    7171        $tags_list = get_the_tag_list( '', $separate_meta );
    7272
    73         // We don't want to output .entry-footer if it will be empty, so make sure its not.
     73        // We don't want to output .entry-footer if it will be empty, so make sure it is not.
    7474        if ( ( ( twentyseventeen_categorized_blog() && $categories_list ) || $tags_list ) || get_edit_post_link() ) {
    7575
    … …  
    113113     * Returns an accessibility-friendly link to edit a post or page.
    114114     *
    115      * This also gives us a little context about what exactly we're editing
     115     * This also gives a little context about what exactly we're editing
    116116     * (post or page?) so that users understand a bit more where they are in terms
    117117     * of the template hierarchy and their content. Helpful when/if the single-page
    … …  
    132132
    133133/**
    134  * Display a front page section.
     134 * Displays a front page section.
    135135 *
    136136 * @global int|string $twentyseventeencounter Front page section counter.
    … …  
    138138 *
    139139 * @param WP_Customize_Partial $partial Partial associated with a selective refresh request.
    140  * @param int                  $id Front page section to display.
     140 * @param int                  $id      Front page section to display.
    141141 */
    142142function twentyseventeen_front_page_section( $partial = null, $id = 0 ) {
    … …  
    206206
    207207/**
    208  * Flush out the transients used in twentyseventeen_categorized_blog.
     208 * Flushes out the transients used in twentyseventeen_categorized_blog.
    209209 */
    210210function twentyseventeen_category_transient_flusher() {
    … …  
    220220if ( ! function_exists( 'wp_body_open' ) ) :
    221221    /**
    222      * Fire the wp_body_open action.
     222     * Fires the wp_body_open action.
    223223     *
    224224     * Added for backward compatibility to support pre-5.2.0 WordPress versions.
    … …  
    228228    function wp_body_open() {
    229229        /**
    230          * Triggered after the opening <body> tag.
     230         * Fires after the opening <body> tag.
    231231         *
    232232         * @since Twenty Seventeen 2.2
Note: See TracChangeset for help on using the changeset viewer.