Changeset 48163

Timestamp:

06/25/2020 09:29:19 AM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Synchronize documentation and variable names in wp_get_(plugin|theme)_file_editable_extensions() for consistency.

Add missing @since tag to wp_get_theme_file_editable_extensions().

See #49572.

File:

• trunk/src/wp-admin/includes/file.php (modified) (3 diffs)

trunk/src/wp-admin/includes/file.php

@@ -175 +175 @@
 
 /**
- * Get list of file extensions that are editable in plugins.
+ * Gets the list of file extensions that are editable in plugins.
  *
  * @since 4.9.0
@@ -183 +183 @@
  */
 function wp_get_plugin_file_editable_extensions( $plugin ) {
-
-    $editable_extensions = array(
-        'bash',
-        'conf',
-        'css',
-        'diff',
-        'htm',
-        'html',
-        'http',
-        'inc',
-        'include',
-        'js',
-        'json',
-        'jsx',
-        'less',
-        'md',
-        'patch',
-        'php',
-        'php3',
-        'php4',
-        'php5',
-        'php7',
-        'phps',
-        'phtml',
-        'sass',
-        'scss',
-        'sh',
-        'sql',
-        'svg',
-        'text',
-        'txt',
-        'xml',
-        'yaml',
-        'yml',
-    );
-
-    /**
-     * Filters file type extensions editable in the plugin editor.
-     *
-     * @since 2.8.0
-     * @since 4.9.0 Added the `$plugin` parameter.
-     *
-     * @param string[] $editable_extensions An array of editable plugin file extensions.
-     * @param string   $plugin              Path to the plugin file relative to the plugins directory.
-     */
-    $editable_extensions = (array) apply_filters( 'editable_extensions', $editable_extensions, $plugin );
-
-    return $editable_extensions;
-}
-
-/**
- * Get list of file extensions that are editable for a given theme.
- *
- * @param WP_Theme $theme Theme object.
- * @return string[] Array of editable file extensions.
- */
-function wp_get_theme_file_editable_extensions( $theme ) {
 
     $default_types = array(
@@ -277 +220 @@
 
     /**
-     * Filters the list of file types allowed for editing in the Theme editor.
+     * Filters the list of file types allowed for editing in the plugin editor.
+     *
+     * @since 2.8.0
+     * @since 4.9.0 Added the `$plugin` parameter.
+     *
+     * @param string[] $default_types An array of editable plugin file extensions.
+     * @param string   $plugin        Path to the plugin file relative to the plugins directory.
+     */
+    $file_types = (array) apply_filters( 'editable_extensions', $default_types, $plugin );
+
+    return $file_types;
+}
+
+/**
+ * Gets the list of file extensions that are editable for a given theme.
+ *
+ * @since 4.9.0
+ *
+ * @param WP_Theme $theme Theme object.
+ * @return string[] Array of editable file extensions.
+ */
+function wp_get_theme_file_editable_extensions( $theme ) {
+
+    $default_types = array(
+        'bash',
+        'conf',
+        'css',
+        'diff',
+        'htm',
+        'html',
+        'http',
+        'inc',
+        'include',
+        'js',
+        'json',
+        'jsx',
+        'less',
+        'md',
+        'patch',
+        'php',
+        'php3',
+        'php4',
+        'php5',
+        'php7',
+        'phps',
+        'phtml',
+        'sass',
+        'scss',
+        'sh',
+        'sql',
+        'svg',
+        'text',
+        'txt',
+        'xml',
+        'yaml',
+        'yml',
+    );
+
+    /**
+     * Filters the list of file types allowed for editing in the theme editor.
      *
      * @since 4.4.0
      *
-     * @param string[] $default_types List of allowed file types.
-     * @param WP_Theme $theme         The current Theme object.
+     * @param string[] $default_types An array of editable theme file extensions.
+     * @param WP_Theme $theme         The current theme object.
      */
     $file_types = apply_filters( 'wp_theme_editor_filetypes', $default_types, $theme );