Twenty Seventeen: Various docblock fixes.

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



Built from https://develop.svn.wordpress.org/trunk@56121


git-svn-id: http://core.svn.wordpress.org/trunk@55633 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
audrasjb 2023-07-01 17:04:24 +00:00
parent afa826e356
commit 4e24d5d690
3 changed files with 17 additions and 13 deletions

View File

@ -1,6 +1,6 @@
<?php
/**
* Additional features to allow styling of the templates
* Additional features to allow styling of the templates.
*
* @package WordPress
* @subpackage Twenty_Seventeen
@ -67,9 +67,11 @@ function twentyseventeen_body_classes( $classes ) {
add_filter( 'body_class', 'twentyseventeen_body_classes' );
/**
* Count our number of active panels.
* Counts the number of our active panels.
*
* Primarily used to see if we have any panels active, duh.
* Primarily used to see if we have any panels active.
*
* @return int The number of active panels.
*/
function twentyseventeen_panel_count() {
@ -95,7 +97,9 @@ function twentyseventeen_panel_count() {
}
/**
* Checks to see if we're on the front page or not.
* Checks to see if we are on the front page or not.
*
* @return bool Whether we are on the front page or not.
*/
function twentyseventeen_is_frontpage() {
return ( is_front_page() && ! is_home() );

View File

@ -1,6 +1,6 @@
<?php
/**
* Custom template tags for this theme
* Custom template tags for this theme.
*
* Eventually, some of the functionality here could be replaced by core features.
*
@ -70,7 +70,7 @@ if ( ! function_exists( 'twentyseventeen_entry_footer' ) ) :
// Get Tags for posts.
$tags_list = get_the_tag_list( '', $separate_meta );
// We don't want to output .entry-footer if it will be empty, so make sure its not.
// We don't want to output .entry-footer if it will be empty, so make sure it is not.
if ( ( ( twentyseventeen_categorized_blog() && $categories_list ) || $tags_list ) || get_edit_post_link() ) {
echo '<footer class="entry-footer">';
@ -112,7 +112,7 @@ if ( ! function_exists( 'twentyseventeen_edit_link' ) ) :
/**
* Returns an accessibility-friendly link to edit a post or page.
*
* This also gives us a little context about what exactly we're editing
* This also gives a little context about what exactly we're editing
* (post or page?) so that users understand a bit more where they are in terms
* of the template hierarchy and their content. Helpful when/if the single-page
* layout with multiple posts/pages shown gets confusing.
@ -131,13 +131,13 @@ if ( ! function_exists( 'twentyseventeen_edit_link' ) ) :
endif;
/**
* Display a front page section.
* Displays a front page section.
*
* @global int|string $twentyseventeencounter Front page section counter.
* @global WP_Post $post Global post object.
*
* @param WP_Customize_Partial $partial Partial associated with a selective refresh request.
* @param int $id Front page section to display.
* @param int $id Front page section to display.
*/
function twentyseventeen_front_page_section( $partial = null, $id = 0 ) {
if ( is_a( $partial, 'WP_Customize_Partial' ) ) {
@ -205,7 +205,7 @@ function twentyseventeen_categorized_blog() {
/**
* Flush out the transients used in twentyseventeen_categorized_blog.
* Flushes out the transients used in twentyseventeen_categorized_blog.
*/
function twentyseventeen_category_transient_flusher() {
if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) {
@ -219,7 +219,7 @@ add_action( 'save_post', 'twentyseventeen_category_transient_flusher' );
if ( ! function_exists( 'wp_body_open' ) ) :
/**
* Fire the wp_body_open action.
* Fires the wp_body_open action.
*
* Added for backward compatibility to support pre-5.2.0 WordPress versions.
*
@ -227,7 +227,7 @@ if ( ! function_exists( 'wp_body_open' ) ) :
*/
function wp_body_open() {
/**
* Triggered after the opening <body> tag.
* Fires after the opening <body> tag.
*
* @since Twenty Seventeen 2.2
*/

View File

@ -16,7 +16,7 @@
*
* @global string $wp_version
*/
$wp_version = '6.3-beta2-56120';
$wp_version = '6.3-beta2-56121';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.