<!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>[12532] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory: Plugin Directory: Import the `Requires Plugins` header on plugin import.</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="http://meta.trac.wordpress.org/changeset/12532">12532</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/12532","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dd32</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-04-12 04:50:46 +0000 (Wed, 12 Apr 2023)</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'>Plugin Directory: Import the `Requires Plugins` header on plugin import.
At present this is not used for anything, and is for future purposes.
See <a href="http://meta.trac.wordpress.org/ticket/6921">#6921</a>, https://core.trac.wordpress.org/ticket/22316. </pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectorycliclassimportphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-import.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryshortcodesclassuploadhandlerphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-upload-handler.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectorycliclassimportphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-import.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-import.php 2023-04-12 01:46:54 UTC (rev 12531)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-import.php 2023-04-12 04:50:46 UTC (rev 12532)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -41,12 +41,13 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Plugin headers that are stored in plugin meta
</span><span class="cx" style="display: block; padding: 0 10px"> public $plugin_headers = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Header => meta_key
- 'Name' => 'header_name',
- 'PluginURI' => 'header_plugin_uri',
- 'Author' => 'header_author',
- 'AuthorURI' => 'header_author_uri',
- 'TextDomain' => 'header_textdomain',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Header => meta_key
+ 'Name' => 'header_name',
+ 'PluginURI' => 'header_plugin_uri',
+ 'Author' => 'header_author',
+ 'AuthorURI' => 'header_author_uri',
+ 'TextDomain' => 'header_textdomain',
+ 'RequiresPlugins' => 'requires_plugins'
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // These headers are stored in these fields, but are handled separately.
</span><span class="cx" style="display: block; padding: 0 10px"> // 'Version' => 'version',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -722,41 +723,75 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Find the plugin headers for the given directory.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $directory The directory of the plugin.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $max_depth The maximum depth to search for files. Default: current directory only.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return object The plugin headers.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public static function find_plugin_headers( $directory ) {
- $files = Filesystem::list_files( $directory, false, '!\.php$!i' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public static function find_plugin_headers( $directory, $max_depth = -1 ) {
+ $files = Filesystem::list_files( $directory, ( $max_depth > 0 ), '!\.php$!i', $max_depth );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! function_exists( 'get_plugin_data' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . 'wp-admin/includes/plugin.php';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Add any additional headers required.
+ add_filter( 'extra_plugin_headers', array( __CLASS__, 'add_extra_plugin_headers' ) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /*
</span><span class="cx" style="display: block; padding: 0 10px"> * Sometimes plugins have multiple files which we detect as a plugin based on the headers.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * We'll return immediately if the file has a `Plugin Name:` header, otherwise
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * We'll break immediately if the file has a `Plugin Name:` header, otherwise
</ins><span class="cx" style="display: block; padding: 0 10px"> * simply return the last set of headers we come across.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $possible_headers = false;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $headers = false;
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $files as $file ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $data = get_plugin_data( $file, false, false );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( array_filter( $data ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $data['Name'] ) {
- return (object) $data;
- } else {
- $possible_headers = (object) $data;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $data['PluginFile'] = $file;
+ $headers = $data;
+
+ if ( $headers['Name'] ) {
+ break;
</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"> }
</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 ( $possible_headers ) {
- return $possible_headers;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ remove_filter( 'extra_plugin_headers', array( __CLASS__, 'add_extra_plugin_headers' ) );
+
+ if ( ! $headers ) {
+ return false;
</ins><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">- return false;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // The extra_plugin_headers filter doesn't let you set the key.
+ foreach ( self::add_extra_plugin_headers( [] ) as $key => $header ) {
+ if (
+ $key != $header &&
+ ! isset( $headers[ $key ] ) &&
+ isset( $headers[ $header ] )
+ ) {
+ $headers[ $key ] = $headers[ $header ];
+ unset( $headers[ $header ] );
+ }
+ }
+
+ return (object) $headers;
</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"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Add support for additional plugin headers prior to WordPress supporting it.
+ *
+ * @param array $headers The headers to look for in plugins.
+ * @return array
+ */
+ public static function add_extra_plugin_headers( $headers ) {
+ // WordPress Plugin Dependencies - See https://meta.trac.wordpress.org/ticket/6921
+ if ( ! isset( $headers['RequiresPlugins'] ) ) {
+ $headers['RequiresPlugins'] = 'Requires Plugins';
+ }
+
+ return $headers;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Look for Gutenberg blocks registered within a single file.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $filename Pathname of the file.
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryshortcodesclassuploadhandlerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-upload-handler.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-upload-handler.php 2023-04-12 01:46:54 UTC (rev 12531)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-upload-handler.php 2023-04-12 04:50:46 UTC (rev 12532)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,6 +1,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><span class="cx" style="display: block; padding: 0 10px"> namespace WordPressdotorg\Plugin_Directory\Shortcodes;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+use WordPressdotorg\Plugin_Directory\CLI\Import;
</ins><span class="cx" style="display: block; padding: 0 10px"> use WordPressdotorg\Plugin_Directory\Readme\Parser;
</span><span class="cx" style="display: block; padding: 0 10px"> use WordPressdotorg\Plugin_Directory\Plugin_Directory;
</span><span class="cx" style="display: block; padding: 0 10px"> use WordPressdotorg\Plugin_Directory\Tools\Filesystem;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -63,14 +64,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $zip_file = $_FILES['zip_file']['tmp_name'];
</span><span class="cx" style="display: block; padding: 0 10px"> $this->plugin_dir = Filesystem::unzip( $zip_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">- $plugin_files = Filesystem::list_files( $this->plugin_dir, true /* Recursive */, '!\.php$!i', 1 /* Depth */ );
- foreach ( $plugin_files as $plugin_file ) {
- $plugin_data = get_plugin_data( $plugin_file, false, false ); // No markup/translation needed.
- if ( ! empty( $plugin_data['Name'] ) ) {
- $this->plugin = $plugin_data;
- $this->plugin_root = dirname( $plugin_file );
- break;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $plugin_data = (array) Import::find_plugin_headers( $this->plugin_dir, 1 /* Max Depth to search */ );
+ if ( ! empty( $plugin_data['Name'] ) ) {
+ $this->plugin = $plugin_data;
+ $this->plugin_root = dirname( $plugin_data['PluginFile'] );
</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"> // Let's check some plugin headers, shall we?
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -261,7 +258,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"> // Check for a valid readme.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $readme = $this->find_readme_file();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $readme = Import::find_readme_file( $this->plugin_root );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $readme ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $error = __( 'Error: The plugin has no readme.', 'wporg-plugins' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -380,6 +377,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'header_author_uri' => $this->plugin['AuthorURI'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'header_textdomain' => $this->plugin['TextDomain'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'header_description' => $this->plugin['Description'],
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'requires_plugins' => $this->plugin['RequiresPlugins'],
</ins><span class="cx" style="display: block; padding: 0 10px"> 'assets_screenshots' => array(),
</span><span class="cx" style="display: block; padding: 0 10px"> 'assets_icons' => array(),
</span><span class="cx" style="display: block; padding: 0 10px"> 'assets_banners' => array(),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -676,26 +674,6 @@
</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">- * Find the plugin readme file.
- *
- * Looks for either a readme.txt or readme.md file, prioritizing readme.txt.
- *
- * @return string The plugin readme.txt or readme.md filename.
- */
- protected function find_readme_file() {
- $files = Filesystem::list_files( $this->plugin_root, false /* non-recursive */, '!^readme\.(txt|md)$!i' );
-
- // Prioritize readme.txt file.
- foreach ( $files as $file ) {
- if ( '.txt' === strtolower( substr( $file, -4 ) ) ) {
- return $file;
- }
- }
-
- return reset( $files );
- }
-
- /**
</del><span class="cx" style="display: block; padding: 0 10px"> * Sends a plugin through Plugin Check.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool Whether the plugin passed the checks.
</span></span></pre>
</div>
</div>
</body>
</html>