Changeset 46410

Timestamp:

10/06/2019 02:21:42 AM (7 years ago)

Author:

SergeyBiryukov

Message:

Docs: Format comments in wp-admin/includes/plugin.php as per the documentation standards.

Props dkarfa.
Fixes #48191.

File:

• trunk/src/wp-admin/includes/plugin.php (modified) (9 diffs)

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

@@ -86 +86 @@
         $plugin_data = get_file_data( $plugin_file, $default_headers, 'plugin' );
 
-        // Site Wide Only is the old header for Network
+        // Site Wide Only is the old header for Network.
         if ( ! $plugin_data['Network'] && $plugin_data['_sitewide'] ) {
                 /* translators: 1: Site Wide Only: true, 2: Network: true */
@@ -143 +143 @@
 function _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup = true, $translate = true ) {
 
-        // Sanitize the plugin filename to a WP_PLUGIN_DIR relative path
+        // Sanitize the plugin filename to a WP_PLUGIN_DIR relative path.
         $plugin_file = plugin_basename( $plugin_file );
 
-        // Translate fields
+        // Translate fields.
         if ( $translate ) {
                 $textdomain = $plugin_data['TextDomain'];
@@ -168 +168 @@
         }
 
-        // Sanitize fields
+        // Sanitize fields.
         $allowed_tags_in_links = array(
                 'abbr'    => array( 'title' => true ),
@@ -197 +197 @@
         $plugin_data['AuthorName'] = $plugin_data['Author'];
 
-        // Apply markup
+        // Apply markup.
         if ( $markup ) {
                 if ( $plugin_data['PluginURI'] && $plugin_data['Name'] ) {
@@ -293 +293 @@
         }
 
-        // Files in wp-content/plugins directory
+        // Files in wp-content/plugins directory.
         $plugins_dir  = @ opendir( $plugin_root );
         $plugin_files = array();
@@ -359 +359 @@
 function get_mu_plugins() {
         $wp_plugins = array();
-        // Files in wp-content/mu-plugins directory
+        // Files in wp-content/mu-plugins directory.
         $plugin_files = array();
 
@@ -432 +432 @@
         $_dropins = _get_dropins();
 
-        // These exist in the wp-content directory
+        // These exist in the wp-content directory.
         $plugins_dir = @opendir( WP_CONTENT_DIR );
         if ( $plugins_dir ) {
@@ -1538 +1538 @@
  * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
  */
-
 function add_users_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
         if ( current_user_can( 'edit_users' ) ) {
@@ -1547 +1546 @@
         return add_submenu_page( $parent, $page_title, $menu_title, $capability, $menu_slug, $function, $position );
 }
+
 /**
  * Add submenu page to the Dashboard main menu.