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

Timestamp:

11/05/2019 09:25:53 PM (6 years ago)

Author:

johnbillion

Message:

Docs: Further improve documentation of known return types, plus other docs fixes.

See #48303

File:

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

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

@@ -1157 +1157 @@
      * @param int $depth Optional. How deep to search for files. Defaults to a flat scan (0 depth). -1 depth is infinite.
      * @param bool $search_parent Optional. Whether to return parent files. Defaults to false.
-     * @return array Array of files, keyed by the path to the file relative to the theme's directory, with the values
-     *               being absolute paths.
+     * @return string[] Array of files, keyed by the path to the file relative to the theme's directory, with the values
+     *                  being absolute paths.
      */
     public function get_files( $type = null, $depth = 0, $search_parent = false ) {
@@ -1175 +1175 @@
      * @since 4.7.0
      *
-     * @return array Array of page templates, keyed by filename and post type,
+     * @return string Array of page templates, keyed by filename and post type,
      *               with the value of the translated header name.
      */
@@ -1234 +1234 @@
      * @param string       $post_type Optional. Post type to get the templates for. Default 'page'.
      *                                If a post is provided, its post type is used.
-     * @return array Array of page templates, keyed by filename, with the value of the translated header name.
+     * @return string[] Array of template header names keyed by the template file name.
      */
     public function get_page_templates( $post = null, $post_type = 'page' ) {
@@ -1249 +1249 @@
          * @since 4.9.6
          *
-         * @param string[]     $post_templates Array of page templates. Keys are filenames,
-         *                                     values are translated names.
+         * @param string[]     $post_templates Array of template header names keyed by the template file name.
          * @param WP_Theme     $this           The theme object.
          * @param WP_Post|null $post           The post being edited, provided for context, or null.
@@ -1266 +1265 @@
          * @since 4.7.0 Added the `$post_type` parameter.
          *
-         * @param string[]     $post_templates Array of page templates. Keys are filenames,
-         *                                     values are translated names.
+         * @param string[]     $post_templates Array of template header names keyed by the template file name.
          * @param WP_Theme     $this           The theme object.
          * @param WP_Post|null $post           The post being edited, provided for context, or null.
@@ -1290 +1288 @@
      *                                         returned path for the found files, particularly when this function
      *                                         recurses to lower depths. Default empty.
-     * @return array|false Array of files, keyed by the path to the file relative to the `$path` directory prepended
-     *                     with `$relative_path`, with the values being absolute paths. False otherwise.
+     * @return string[]|false Array of files, keyed by the path to the file relative to the `$path` directory prepended
+     *                        with `$relative_path`, with the values being absolute paths. False otherwise.
      */
     private static function scandir( $path, $extensions = null, $depth = 0, $relative_path = '' ) {