<!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>[10049] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-block-validator.php: Plugin directory: show expandable details for validator messages.</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/10049">10049</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/10049","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>tellyworth</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-07-10 01:20:10 +0000 (Fri, 10 Jul 2020)</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: show expandable details for validator messages.
Props ryelle.
See <a href="http://meta.trac.wordpress.org/ticket/5303">#5303</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryshortcodesclassblockvalidatorphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-block-validator.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryshortcodesclassblockvalidatorphp"></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-block-validator.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-block-validator.php 2020-07-10 01:17:26 UTC (rev 10048)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-block-validator.php 2020-07-10 01:20:10 UTC (rev 10049)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -58,9 +58,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected static function plugin_is_in_block_directory( $slug ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $plugin = Plugin_Directory::get_plugin_post( $slug );
</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 (
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return (
</ins><span class="cx" style="display: block; padding: 0 10px"> $plugin &&
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $plugin->post_name === $slug &&
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $plugin->post_name === $slug &&
</ins><span class="cx" style="display: block; padding: 0 10px"> has_term( 'block', 'plugin_section', $plugin )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -88,8 +88,13 @@
</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"> $results_by_type = array();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $block_json_issues = array();
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $results as $item ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $results_by_type[ $item->type ][] = $item;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 'check_block_json_is_valid' === $item->check_name ) {
+ $block_json_issues[] = $item;
+ } else {
+ $results_by_type[ $item->type ][] = $item;
+ }
</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"> if ( $checker->slug ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -101,16 +106,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> echo '<input type="hidden" name="plugin-id" value="' . esc_attr( $plugin->ID ) . '" />';
</span><span class="cx" style="display: block; padding: 0 10px"> echo '<p>';
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $results_by_type['error'] ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // translators: %s plugin title.
</ins><span class="cx" style="display: block; padding: 0 10px"> printf( __( "%s can't be added to the block directory, due to errors in validation.", 'wporg-plugins' ), $plugin->post_title );
</span><span class="cx" style="display: block; padding: 0 10px"> } else if ( self::plugin_is_in_block_directory( $checker->slug ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // translators: %s plugin title.
</ins><span class="cx" style="display: block; padding: 0 10px"> echo '<button type="submit" name="block-directory-edit" value="remove">' . sprintf( __( 'Remove %s from Block Directory', 'wporg-plugins' ), $plugin->post_title ) . '</button>';
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // translators: %s plugin title.
</ins><span class="cx" style="display: block; padding: 0 10px"> echo '<button type="submit" name="block-directory-edit" value="add">' . sprintf( __( 'Add %s to Block Directory', 'wporg-plugins' ), $plugin->post_title ) . '</button>';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> echo '</p>';
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> echo '<ul><li><a href="' . get_edit_post_link( $plugin->ID ) . '">' . __( 'Edit plugin', 'wporg-plugins' ) . '</a></li>';
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- echo '<li><a href="' . esc_url( 'https://plugins.trac.wordpress.org/browser/' . $checker->slug . '/trunk' ) .'">' . __( 'Trac browser', 'wporg-plugins' ) . '</a></li></ul>';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ echo '<li><a href="' . esc_url( 'https://plugins.trac.wordpress.org/browser/' . $checker->slug . '/trunk' ) . '">' . __( 'Trac browser', 'wporg-plugins' ) . '</a></li></ul>';
</ins><span class="cx" style="display: block; padding: 0 10px"> echo '</form>';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -145,15 +153,26 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $output .= "<h3>{$warning_label}</h3>\n";
</span><span class="cx" style="display: block; padding: 0 10px"> $output .= "<div class='notice notice-{$type} notice-alt'>\n";
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $output .= "<ul class='{$type}'>\n";
</del><span class="cx" style="display: block; padding: 0 10px"> foreach ( $results_by_type[ $type ] as $item ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $docs_link = '';
- if ( 'check' === substr( $item->check_name, 0, 5 ) ) {
- $docs_link = "<a href='help#{$item->check_name}'>" . __( 'More about this.', 'wporg-plugins' ) . '</a>';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Only get details if this is a warning or error.
+ $details = ( 'info' === $type ) ? false : self::get_detailed_help( $item->check_name );
+ if ( $details ) {
+ $details = '<p>' . implode( '</p><p>', (array) $details ) . '</p>';
+ $output .= "<details class='{$item->check_name}'><summary>{$item->message}</summary>{$details}</details>";
+ } else {
+ $output .= "<p>{$item->message}</p>";
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $output .= "<li class='{$item->check_name}'>{$item->message} {$docs_link}</li>\n";
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $output .= "</ul>\n";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Collapse block.json warnings into one details at the end of warnings list.
+ if ( 'warning' === $type && ! empty( $block_json_issues ) ) {
+ $messages = wp_list_pluck( $block_json_issues, 'message' );
+ $details = '<p>' . implode( '</p><p>', (array) $messages ) . '</p>';
+ $output .= sprintf(
+ '<details class="check_block_json_is_valid"><summary>%1$s</summary>%2$s</details>',
+ __( 'Issues found in block.json file.', 'wporg-plugins' ),
+ $details
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> $output .= "</div>\n";
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -165,4 +184,51 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> echo $output;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Get a more detailed help message for a given check.
+ *
+ * @param string $method The name of the check method.
+ *
+ * @return string|array More details for a given block issue. Array of strings if there should be a linebreak.
+ */
+ public static function get_detailed_help( $method ) {
+ switch ( $method ) {
+ // These don't need more details.
+ case 'check_readme_exists':
+ case 'check_license':
+ case 'check_plugin_headers':
+ return false;
+ // This is a special case, since multiple values may be collapsed.
+ case 'check_block_json_is_valid':
+ return false;
+ case 'check_block_tag':
+ return __( 'The readme.txt file must contain the tag "block" for this to be added to the block directory.', 'wporg-plugins' );
+ case 'check_for_duplicate_block_name':
+ return [
+ __( "Block names must be unique, otherwise it can cause problems when using the block. It is recommended to use your plugin's name as the namespace.", 'wporg-plugins' ),
+ '<em>' . __( 'If this is a different version of your own plugin, you can ignore this warning.', 'wporg-plugins' ) . '</em>',
+ ];
+ case 'check_for_blocks':
+ return [
+ __( 'In order to work in the Block Directory, a plugin must register a block. Generally one per plugin (multiple blocks may be permitted if those blocks are interdependent, such as a list block that contains list item blocks).', 'wporg-plugins' ),
+ __( 'If your plugin doesn’t register a block, it probably belongs in the main Plugin Directory rather than the Block Directory.', 'wporg-plugins' ),
+ sprintf( '<a href="TUTORIAL">%s</a>', __( 'Learn how to create a block.' ) ),
+ ];
+ case 'check_for_block_json':
+ return __( 'Your plugin should contain at least one <code>block.json</code> file. This file contains metadata describing the block and its JavaScript and CSS assets. Make sure you include at least one <code>script</code> or <code>editorScript</code> item.', 'wporg-plugins' );
+ case 'check_for_block_scripts':
+ return 'TODO';
+ case 'check_for_block_script_files':
+ return 'TODO';
+ case 'check_for_register_block_type':
+ return __( 'At least one of your JavaScript files must explicitly call registerBlockType(). Without that call, your block will not work in the editor.', 'wporg-plugins' );
+ case 'check_block_json_is_valid_json':
+ return __( 'This block.json file is invalid. The Block Directory needs to be able to read this file.', 'wporg-plugins' );
+ case 'check_asset_php_file':
+ return 'TODO'; // Is this really an issue?
+ case 'check_php_size':
+ return __( 'Block plugins should keep the PHP code to a mimmum. If you need a lot of PHP code, your plugin probably belongs in the main Plugin Directory rather than the Block Directory.', 'wporg-plugins' );
+ }
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>