<!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>[45917] trunk/src: Docs: Simplify `get_plugin_data()` and `get_file_data()` description.</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/45917">45917</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/45917","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-08-30 16:56:39 +0000 (Fri, 30 Aug 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: Simplify `get_plugin_data()` and `get_file_data()` description.
See <a href="https://core.trac.wordpress.org/ticket/47110">#47110</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludespluginphp">trunk/src/wp-admin/includes/plugin.php</a></li>
<li><a href="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.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-08-30 16:15:32 UTC (rev 45916)
+++ trunk/src/wp-admin/includes/plugin.php 2019-08-30 16:56:39 UTC (rev 45917)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -9,10 +9,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Parses the plugin contents to retrieve plugin's metadata.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The metadata of the plugin's data searches for the following in the plugin's
- * header. All plugin data must be on its own line. For plugin description, it
- * must not have any newlines or only parts of the description will be displayed
- * and the same goes for the plugin data. The below is formatted for printing.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * All plugin headers must be on their own line. Plugin description must not have
+ * any newlines, otherwise only parts of the description will be displayed.
+ * The below is formatted for printing.
</ins><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"> * Plugin Name: Name of the plugin.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -33,14 +32,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * activated on a single site when Multisite is enabled.
</span><span class="cx" style="display: block; padding: 0 10px"> * Requires at least: Optional. Specify the minimum required WordPress version.
</span><span class="cx" style="display: block; padding: 0 10px"> * Requires PHP: Optional. Specify the minimum required PHP version.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * * / # Remove the space to close comment
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * * / # Remove the space to close comment.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Some users have issues with opening large files and manipulating the contents
- * for want is usually the first 1kiB or 2kiB. This function stops pulling in
- * the plugin contents when it has all of the required plugin data.
- *
- * The first 8kiB of the file will be pulled in and if the plugin data is not
- * within that first 8kiB, then the plugin author should correct their plugin
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The first 8 KB of the file will be pulled in and if the plugin data is not
+ * within that first 8 KB, then the plugin author should correct their plugin
</ins><span class="cx" style="display: block; padding: 0 10px"> * and move the plugin data headers to the top.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The plugin file is assumed to have permissions to allow for scripts to read
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -48,7 +43,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * reading.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 5.3.0 Added support for `Requires at least` and `Requires PHP`.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.3.0 Added support for `Requires at least` and `Requires PHP` headers.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $plugin_file Absolute path to the main plugin file.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $markup Optional. If the returned data should have HTML markup applied.
</span></span></pre></div>
<a id="trunksrcwpincludesfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/functions.php 2019-08-30 16:15:32 UTC (rev 45916)
+++ trunk/src/wp-includes/functions.php 2019-08-30 16:56:39 UTC (rev 45917)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5684,11 +5684,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieve metadata from a 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">- * Searches for metadata in the first 8kiB of a file, such as a plugin or theme.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Searches for metadata in the first 8 KB of a file, such as a plugin or theme.
</ins><span class="cx" style="display: block; padding: 0 10px"> * Each piece of metadata must be on its own line. Fields can not span multiple
</span><span class="cx" style="display: block; padding: 0 10px"> * lines, the value will get cut at the end of the first line.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * If the file data is not within that first 8kiB, then the author should correct
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * If the file data is not within that first 8 KB, then the author should correct
</ins><span class="cx" style="display: block; padding: 0 10px"> * their plugin file and move the data headers to the top.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @link https://codex.wordpress.org/File_Header
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5696,7 +5696,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $file Absolute path to the file.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $default_headers List of headers, in the format `array('HeaderKey' => 'Header Name')`.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $default_headers List of headers, in the format `array( 'HeaderKey' => 'Header Name' )`.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $context Optional. If specified adds filter hook {@see 'extra_$context_headers'}.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array Array of file headers in `HeaderKey => Header Value` format.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5705,7 +5705,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // We don't need to write to the file, so just open for reading.
</span><span class="cx" style="display: block; padding: 0 10px"> $fp = fopen( $file, 'r' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Pull only the first 8kiB of the file in.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Pull only the first 8 KB of the file in.
</ins><span class="cx" style="display: block; padding: 0 10px"> $file_data = fread( $fp, 8 * KB_IN_BYTES );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // PHP will close file handle, but we are good citizens.
</span></span></pre>
</div>
</div>
</body>
</html>