Changeset 42007 for trunk/src/wp-admin/includes/file.php

Timestamp:

10/24/2017 10:49:13 PM (9 years ago)

Author:

johnbillion

Message:

Docs: Improve the docs for validate_file() and validate_file_to_edit().

See #42016, #36170, #41017

File:

• trunk/src/wp-admin/includes/file.php (modified) (1 diff)

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

@@ -654 +654 @@
 
 /**
- * Make sure that the file that was requested to edit, is allowed to be edited
- *
- * Function will die if you are not allowed to edit the file
+ * Makes sure that the file that was requested to be edited is allowed to be edited.
+ *
+ * Function will die if you are not allowed to edit the file.
  *
  * @since 1.5.0
  *
- * @param string $file file the users is attempting to edit
- * @param array $allowed_files Array of allowed files to edit, $file must match an entry exactly
+ * @param string $file          File the user is attempting to edit.
+ * @param array  $allowed_files Optional. Array of allowed files to edit, $file must match an entry exactly.
  * @return string|null
  */