Changeset 42876 for trunk/src/wp-includes/class-wp-theme.php

Timestamp:

03/25/2018 07:32:24 PM (8 years ago)

Author:

johnbillion

Message:

Docs: Document more parameters and properties using typed array notation.

See #41756

File:

• trunk/src/wp-includes/class-wp-theme.php (modified) (10 diffs)

trunk/src/wp-includes/class-wp-theme.php

@@ -1192 +1192 @@
                  * @since 4.7.0 Added the `$post_type` parameter.
                  *
-                 * @param array        $post_templates Array of page templates. Keys are filenames,
+                 * @param string[]     $post_templates Array of page templates. Keys are filenames,
                  *                                     values are translated names.
                  * @param WP_Theme     $this           The theme object.
@@ -1240 +1240 @@
                  * @since 4.7.4
                  *
-                 * @param array $exclusions Array of excluded directories and files.
+                 * @param string[] $exclusions Array of excluded directories and files.
                  */
                 $exclusions = (array) apply_filters( 'theme_scandir_exclusions', array( 'CVS', 'node_modules', 'vendor', 'bower_components' ) );
@@ -1357 +1357 @@
          *
          * @param int $blog_id Optional. ID of the site. Defaults to the current site.
-         * @return array Array of stylesheet names.
+         * @return string[] Array of stylesheet names.
          */
         public static function get_allowed( $blog_id = null ) {
@@ -1368 +1368 @@
                  * @since 4.5.0
                  *
-                 * @param array $allowed_themes An array of theme stylesheet names.
-                 * @param int   $blog_id        ID of the site.
+                 * @param string[] $allowed_themes An array of theme stylesheet names.
+                 * @param int      $blog_id        ID of the site.
                  */
                 $network = (array) apply_filters( 'network_allowed_themes', self::get_allowed_on_network(), $blog_id );
@@ -1382 +1382 @@
          * @staticvar array $allowed_themes
          *
-         * @return array Array of stylesheet names.
+         * @return string[] Array of stylesheet names.
          */
         public static function get_allowed_on_network() {
@@ -1395 +1395 @@
                  * @since MU (3.0.0)
                  *
-                 * @param array $allowed_themes An array of theme stylesheet names.
+                 * @param string[] $allowed_themes An array of theme stylesheet names.
                  */
                 $allowed_themes = apply_filters( 'allowed_themes', $allowed_themes );
@@ -1410 +1410 @@
          *
          * @param int $blog_id Optional. ID of the site. Defaults to the current site.
-         * @return array Array of stylesheet names.
+         * @return string[] Array of stylesheet names.
          */
         public static function get_allowed_on_site( $blog_id = null ) {
@@ -1425 +1425 @@
                          * @since 4.5.0
                          *
-                         * @param array $allowed_themes An array of theme stylesheet names.
-                         * @param int   $blog_id        ID of the site. Defaults to current site.
+                         * @param string[] $allowed_themes An array of theme stylesheet names.
+                         * @param int      $blog_id        ID of the site. Defaults to current site.
                          */
                         return (array) apply_filters( 'site_allowed_themes', $allowed_themes[ $blog_id ], $blog_id );
@@ -1487 +1487 @@
          * @since 4.6.0
          *
-         * @param string|array $stylesheets Stylesheet name or array of stylesheet names.
+         * @param string|string[] $stylesheets Stylesheet name or array of stylesheet names.
          */
         public static function network_enable_theme( $stylesheets ) {
@@ -1511 +1511 @@
          * @since 4.6.0
          *
-         * @param string|array $stylesheets Stylesheet name or array of stylesheet names.
+         * @param string|string[] $stylesheets Stylesheet name or array of stylesheet names.
          */
         public static function network_disable_theme( $stylesheets ) {