Changeset 38578

Timestamp:

09/08/2016 10:53:57 PM (8 years ago)

Author:

johnbillion

Message:

Themes: Improve child theme file inheritance by introducing functions for locating and fetching the URL or path to files within child and parent themes.

The most useful function this introduces is get_theme_file_uri(), which returns the URL to the specified file in the child theme if it exists, and falls back to the URL to the specified file in the parent theme. This allows parent themes to reference files (including enqueuing CSS and JavaScript files) that can be overridden by the child theme simply by existing.

This change also introduces get_theme_file_path(), which is the file path equivalent of get_theme_file_uri().

Finally, get_parent_theme_file_uri() and get_parent_theme_file_path() are also introduced, which allow a theme to specifically reference a file URL or file path in the parent theme. These can be used as replacements for get_template_directory_uri() and get_template_directory() respectively, for consistency.

Props johnbillion, georgestephanis, gma992.
Fixes #18302

Location:

trunk

Files:

• src/wp-includes/link-template.php (modified) (3 diffs)
• tests/phpunit/data/theme-file-child (added)
• tests/phpunit/data/theme-file-child/child-only.php (added)
• tests/phpunit/data/theme-file-child/parent-and-child.php (added)
• tests/phpunit/data/theme-file-child/style.css (added)
• tests/phpunit/data/theme-file-parent (added)
• tests/phpunit/data/theme-file-parent/parent-and-child.php (added)
• tests/phpunit/data/theme-file-parent/parent-only.php (added)
• tests/phpunit/data/theme-file-parent/style.css (added)
• tests/phpunit/tests/link/themeFile.php (added)

trunk/src/wp-includes/link-template.php

@@ -931 +931 @@
 
     $tax = get_taxonomy( $term->taxonomy );
-    if ( ! $tax || ! current_user_can( $tax->cap->edit_terms ) ) {
+    if ( ! $tax || ! current_user_can( 'edit_term', $term->term_id ) ) {
         return;
     }
@@ -985 +985 @@
 
     $tax = get_taxonomy( $term->taxonomy );
-    if ( ! current_user_can( $tax->cap->edit_terms ) )
+    if ( ! current_user_can( 'edit_term', $term->term_id ) ) {
         return;
+    }
 
     if ( empty( $link ) )
@@ -4024 +4025 @@
     return apply_filters( 'get_avatar_data', $args, $id_or_email );
 }
+
+/**
+ * Retrieve the URL of a file in the theme.
+ *
+ * Searches in the stylesheet directory before the template directory so themes
+ * which inherit from a parent theme can just override one file.
+ *
+ * @since 4.7.0
+ *
+ * @param string $file Optional. File to search for in the stylesheet directory.
+ * @return string The URL of the file.
+ */
+function get_theme_file_uri( $file = '' ) {
+    $file = ltrim( $file, '/' );
+
+    if ( empty( $file ) ) {
+        $url = get_stylesheet_directory_uri();
+    } elseif ( file_exists( get_stylesheet_directory() . '/' . $file ) ) {
+        $url = get_stylesheet_directory_uri() . '/' . $file;
+    } else {
+        $url = get_template_directory_uri() . '/' . $file;
+    }
+
+    /**
+     * Filter the URL to a file in the theme.
+     *
+     * @since 4.7.0
+     *
+     * @param string $url  The file URL.
+     * @param string $file The requested file to search for.
+     */
+    return apply_filters( 'theme_file_uri', $url, $file );
+}
+
+/**
+ * Retrieve the URL of a file in the parent theme.
+ *
+ * @since 4.7.0
+ *
+ * @param string $file Optional. File to return the URL for in the template directory.
+ * @return string The URL of the file.
+ */
+function get_parent_theme_file_uri( $file = '' ) {
+    $file = ltrim( $file, '/' );
+
+    if ( empty( $file ) ) {
+        $url = get_template_directory_uri();
+    } else {
+        $url = get_template_directory_uri() . '/' . $file;
+    }
+
+    /**
+     * Filter the URL to a file in the parent theme.
+     *
+     * @since 4.7.0
+     *
+     * @param string $url  The file URL.
+     * @param string $file The requested file to search for.
+     */
+    return apply_filters( 'parent_theme_file_uri', $url, $file );
+}
+
+/**
+ * Retrieve the path of a file in the theme.
+ *
+ * Searches in the stylesheet directory before the template directory so themes
+ * which inherit from a parent theme can just override one file.
+ *
+ * @since 4.7.0
+ *
+ * @param string $file Optional. File to search for in the stylesheet directory.
+ * @return string The path of the file.
+ */
+function get_theme_file_path( $file = '' ) {
+    $file = ltrim( $file, '/' );
+
+    if ( empty( $file ) ) {
+        $path = get_stylesheet_directory();
+    } elseif ( file_exists( get_stylesheet_directory() . '/' . $file ) ) {
+        $path = get_stylesheet_directory() . '/' . $file;
+    } else {
+        $path = get_template_directory() . '/' . $file;
+    }
+
+    /**
+     * Filter the path to a file in the theme.
+     *
+     * @since 4.7.0
+     *
+     * @param string $path The file path.
+     * @param string $file The requested file to search for.
+     */
+    return apply_filters( 'theme_file_path', $path, $file );
+}
+
+/**
+ * Retrieve the path of a file in the parent theme.
+ *
+ * @since 4.7.0
+ *
+ * @param string $file Optional. File to return the path for in the template directory.
+ * @return string The path of the file.
+ */
+function get_parent_theme_file_path( $file = '' ) {
+    $file = ltrim( $file, '/' );
+
+    if ( empty( $file ) ) {
+        $path = get_template_directory();
+    } else {
+        $path = get_template_directory() . '/' . $file;
+    }
+
+    /**
+     * Filter the path to a file in the parent theme.
+     *
+     * @since 4.7.0
+     *
+     * @param string $path The file path.
+     * @param string $file The requested file to search for.
+     */
+    return apply_filters( 'parent_theme_file_path', $path, $file );
+}