Skip to content

Commit 4c5b273

Browse files
Twenty Seventeen: Add missing documentation for some global variables.
Props sabernhardt, upadalavipul, shailu25, rajinsharwar, audrasjb, viralsampat, noruzzaman, huzaifaalmesbah, SergeyBiryukov. See #58715. git-svn-id: https://develop.svn.wordpress.org/trunk@62472 602fd350-edb4-49c9-b593-d223f7449a82
1 parent 8a9d768 commit 4c5b273

3 files changed

Lines changed: 13 additions & 4 deletions

File tree

src/wp-content/themes/twentyseventeen/functions.php

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111

1212
/**
1313
* Twenty Seventeen only works in WordPress 4.7 or later.
14+
*
15+
* @global string $wp_version The WordPress version string.
1416
*/
1517
if ( version_compare( $GLOBALS['wp_version'], '4.7-alpha', '<' ) ) {
1618
require get_template_directory() . '/inc/back-compat.php';
@@ -23,6 +25,10 @@
2325
* Note that this function is hooked into the after_setup_theme hook, which
2426
* runs before the init hook. The init hook is too late for some features, such
2527
* as indicating support for post thumbnails.
28+
*
29+
* @since Twenty Seventeen 1.0
30+
*
31+
* @global int $content_width Content width.
2632
*/
2733
function twentyseventeen_setup() {
2834

@@ -248,7 +254,7 @@ function twentyseventeen_setup() {
248254
*
249255
* Priority 0 to make it available to lower priority callbacks.
250256
*
251-
* @global int $content_width
257+
* @global int $content_width Content width.
252258
*/
253259
function twentyseventeen_content_width() {
254260

src/wp-content/themes/twentyseventeen/inc/back-compat.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ function twentyseventeen_switch_theme() {
3333
*
3434
* @since Twenty Seventeen 1.0
3535
*
36-
* @global string $wp_version WordPress version.
36+
* @global string $wp_version The WordPress version string.
3737
*/
3838
function twentyseventeen_upgrade_notice() {
3939
printf(
@@ -51,7 +51,7 @@ function twentyseventeen_upgrade_notice() {
5151
*
5252
* @since Twenty Seventeen 1.0
5353
*
54-
* @global string $wp_version WordPress version.
54+
* @global string $wp_version The WordPress version string.
5555
*/
5656
function twentyseventeen_customize() {
5757
wp_die(
@@ -73,7 +73,7 @@ function twentyseventeen_customize() {
7373
*
7474
* @since Twenty Seventeen 1.0
7575
*
76-
* @global string $wp_version WordPress version.
76+
* @global string $wp_version The WordPress version string.
7777
*/
7878
function twentyseventeen_preview() {
7979
if ( isset( $_GET['preview'] ) ) {

src/wp-content/themes/twentyseventeen/template-parts/page/content-front-page-panels.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
* @version 1.0
99
*/
1010

11+
/**
12+
* @global int|string $twentyseventeencounter Front page section counter.
13+
*/
1114
global $twentyseventeencounter;
1215

1316
?>

0 commit comments

Comments
 (0)