<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[46410] trunk/src/wp-admin/includes/plugin.php: Docs: Format comments in `wp-admin/includes/plugin.php` as per the documentation standards.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/46410">46410</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/46410","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-10-06 02:21:42 +0000 (Sun, 06 Oct 2019)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Format comments in `wp-admin/includes/plugin.php` as per the documentation standards.
Props dkarfa.
Fixes <a href="https://core.trac.wordpress.org/ticket/48191">#48191</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludespluginphp">trunk/src/wp-admin/includes/plugin.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludespluginphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/plugin.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/plugin.php 2019-10-05 21:59:32 UTC (rev 46409)
+++ trunk/src/wp-admin/includes/plugin.php 2019-10-06 02:21:42 UTC (rev 46410)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -85,7 +85,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $plugin_data = get_file_data( $plugin_file, $default_headers, 'plugin' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Site Wide Only is the old header for Network
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Site Wide Only is the old header for Network.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! $plugin_data['Network'] && $plugin_data['_sitewide'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> /* translators: 1: Site Wide Only: true, 2: Network: true */
</span><span class="cx" style="display: block; padding: 0 10px"> _deprecated_argument( __FUNCTION__, '3.0.0', sprintf( __( 'The %1$s plugin header is deprecated. Use %2$s instead.' ), '<code>Site Wide Only: true</code>', '<code>Network: true</code>' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -142,10 +142,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup = true, $translate = true ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Sanitize the plugin filename to a WP_PLUGIN_DIR relative path
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Sanitize the plugin filename to a WP_PLUGIN_DIR relative path.
</ins><span class="cx" style="display: block; padding: 0 10px"> $plugin_file = plugin_basename( $plugin_file );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Translate fields
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Translate fields.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $translate ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $textdomain = $plugin_data['TextDomain'];
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $textdomain ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -167,7 +167,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Sanitize fields
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Sanitize fields.
</ins><span class="cx" style="display: block; padding: 0 10px"> $allowed_tags_in_links = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'abbr' => array( 'title' => true ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'acronym' => array( 'title' => true ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -196,7 +196,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $plugin_data['Title'] = $plugin_data['Name'];
</span><span class="cx" style="display: block; padding: 0 10px"> $plugin_data['AuthorName'] = $plugin_data['Author'];
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Apply markup
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Apply markup.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $markup ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $plugin_data['PluginURI'] && $plugin_data['Name'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $plugin_data['Title'] = '<a href="' . $plugin_data['PluginURI'] . '">' . $plugin_data['Name'] . '</a>';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -292,7 +292,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $plugin_root .= $plugin_folder;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Files in wp-content/plugins directory
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Files in wp-content/plugins directory.
</ins><span class="cx" style="display: block; padding: 0 10px"> $plugins_dir = @ opendir( $plugin_root );
</span><span class="cx" style="display: block; padding: 0 10px"> $plugin_files = array();
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $plugins_dir ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -358,7 +358,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_mu_plugins() {
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_plugins = array();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Files in wp-content/mu-plugins directory
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Files in wp-content/mu-plugins directory.
</ins><span class="cx" style="display: block; padding: 0 10px"> $plugin_files = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_dir( WPMU_PLUGIN_DIR ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -431,7 +431,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $_dropins = _get_dropins();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // These exist in the wp-content directory
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // These exist in the wp-content directory.
</ins><span class="cx" style="display: block; padding: 0 10px"> $plugins_dir = @opendir( WP_CONTENT_DIR );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $plugins_dir ) {
</span><span class="cx" style="display: block; padding: 0 10px"> while ( ( $file = readdir( $plugins_dir ) ) !== false ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1537,7 +1537,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $position The position in the menu order this item should appear.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> function add_users_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( current_user_can( 'edit_users' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $parent = 'users.php';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1546,6 +1545,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> return add_submenu_page( $parent, $page_title, $menu_title, $capability, $menu_slug, $function, $position );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Add submenu page to the Dashboard main menu.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre>
</div>
</div>
</body>
</html>