<!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>[9465] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-template.php: Plugin Directory: Template: Define the Schema in PHP before being output as a JSON literal.</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/9465">9465</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/9465","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>2020-02-05 05:12:50 +0000 (Wed, 05 Feb 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: Template: Define the Schema in PHP before being output as a JSON literal.
This change also makes the URL escaping consistent by not escaping slashes.
See <a href="http://meta.trac.wordpress.org/ticket/4998">#4998</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryclasstemplatephp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryclasstemplatephp"></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/class-template.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/class-template.php 2020-02-04 21:17:13 UTC (rev 9464)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-template.php 2020-02-05 05:12:50 UTC (rev 9465)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -22,40 +22,45 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @static
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function json_ld_schema() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $schema = false;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Schema for the front page.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_front_page() ) :
- echo PHP_EOL;
- ?>
-<script type="application/ld+json">
- {
- "@context": "http://schema.org",
- "@type": "WebSite",
- "name": <?php echo wp_json_encode( __( 'WordPress Plugins', 'wporg-plugins' ) ); ?>,
- "url": <?php echo wp_json_encode( home_url( '/' ) ); ?>,
- "potentialAction": [
- {
- "@type": "SearchAction",
- "target": <?php echo wp_json_encode( home_url( '?s={search_term_string}' ) ); ?>,
- "query-input": "required name=search_term_string"
- }
- ]
- }
-</script>
- <?php
- endif;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_front_page() ) {
+ $schema = [
+ "@context" => "http://schema.org",
+ "@type" => "WebSite",
+ "name" => __( 'WordPress Plugins', 'wporg-plugins' ),
+ "url" => home_url( '/' ),
+ "potentialAction" => [
+ [
+ "@type" => "SearchAction",
+ "target" => home_url( '?s={search_term_string}' ),
+ "query-input" => "required name=search_term_string"
+ ]
+ ]
+ ];
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Schema for plugin pages.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_singular( 'plugin' ) && 'publish' === get_post_status( get_queried_object_id() ) ) {
- self::plugin_json_jd_schema( get_queried_object() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( is_singular( 'plugin' ) && 'publish' === get_post_status( get_queried_object_id() ) ) {
+ $schema = self::plugin_json_jd_schema( get_queried_object() );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Print the schema.
+ if ( $schema ) {
+ echo PHP_EOL, '<script type="application/ld+json">', PHP_EOL;
+ // Output URLs without escaping the slashes, and print it human readable.
+ echo wp_json_encode( $schema, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT );
+ echo PHP_EOL, '</script>', PHP_EOL;
+ }
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Prints JSON LD schema for a specific plugin.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Fetches JSON LD schema for a specific plugin.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @static
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param \WP_Post $plugin Plugin to output JSON LD Schema for.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array Schema object.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected static function plugin_json_jd_schema( $plugin ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $rating = get_post_meta( $plugin->ID, 'rating', true ) ?: 0;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -62,69 +67,71 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $ratings = get_post_meta( $plugin->ID, 'ratings', true ) ?: [];
</span><span class="cx" style="display: block; padding: 0 10px"> $num_ratings = array_sum( $ratings );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- echo PHP_EOL;
- ?>
-<script type="application/ld+json">
- [
- {
- "@context": "http://schema.org",
- "@type": "BreadcrumbList",
- "itemListElement": [
- {
- "@type": "ListItem",
- "position": 1,
- "item": {
- "@id": "https://wordpress.org/",
- "name": "WordPress"
- }
- },
- {
- "@type": "ListItem",
- "position": 2,
- "item": {
- "@id": <?php echo wp_json_encode( home_url( '/' ) ); ?>,
- "name": <?php echo wp_json_encode( __( 'WordPress Plugins', 'wporg-plugins' ) ) . PHP_EOL; ?>
- }
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $schema = [];
+
+ // Add the BreadcrumbList node.
+ $breadcrumb_list = [
+ "@context" => "http://schema.org",
+ "@type" => "BreadcrumbList",
+ "itemListElement" => [
+ [
+ "@type" => "ListItem",
+ "position" => 1,
+ "item" => [
+ "@id" => "https://wordpress.org/",
+ "name" => "WordPress"
+ ]
+ ],
+ [
+ "@type" => "ListItem",
+ "position" => 2,
+ "item" => [
+ "@id" => home_url( '/' ),
+ "name" => __( 'WordPress Plugins', 'wporg-plugins' ),
+ ]
+ ]
</ins><span class="cx" style="display: block; padding: 0 10px"> ]
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- },
- {
- "@context": "http://schema.org",
- "@type": "SoftwareApplication",
- "applicationCategory": "http://schema.org/OtherApplication",
- "name": <?php echo wp_json_encode( get_the_title( $plugin ) ); ?>,
- "description": <?php echo wp_json_encode( get_the_excerpt( $plugin ) ); ?>,
- "softwareVersion": <?php echo wp_json_encode( $plugin->version ); ?>,
- "fileFormat": "application/zip",
- "downloadUrl": <?php echo wp_json_encode( self::download_link( $plugin ) ); ?>,
- "dateModified": <?php echo wp_json_encode( get_post_modified_time( 'c', false, $plugin ) ); ?>,
- "aggregateRating": {
- "@type": "AggregateRating",
- "worstRating": 0,
- "bestRating": 5,
- "ratingValue": <?php echo wp_json_encode( $rating ); ?>,
- "ratingCount": <?php echo wp_json_encode( $num_ratings ); ?>,
- "reviewCount": <?php echo wp_json_encode( $num_ratings ) . PHP_EOL; ?>
- },
- "interactionStatistic": {
- "@type": "InteractionCounter",
- "interactionType": "http://schema.org/DownloadAction",
- "userInteractionCount": <?php echo wp_json_encode( self::get_downloads_count( $plugin ) ) . PHP_EOL; ?>
- },
- "offers": {
- "@type": "Offer",
- "price": "0.00",
- "priceCurrency": "USD",
- "seller": {
- "@type": "Organization",
- "name": "WordPress.org",
- "url": "https://wordpress.org"
- }
- }
- }
- ]
-</script>
- <?php
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ ];
+ $schema[] = $breadcrumb_list;
+
+ // Add the Plugin 'SoftwareApplication' node.
+ $software_application = [
+ "@context" => "http://schema.org",
+ "@type" => "SoftwareApplication",
+ "applicationCategory" => "http://schema.org/OtherApplication",
+ "name" => get_the_title( $plugin ),
+ "description" => get_the_excerpt( $plugin ),
+ "softwareVersion" => $plugin->version,
+ "fileFormat" => "application/zip",
+ "downloadUrl" => self::download_link( $plugin ),
+ "dateModified" => get_post_modified_time( 'c', false, $plugin ),
+ "aggregateRating" => [
+ "@type" => "AggregateRating",
+ "worstRating" => 0,
+ "bestRating" => 5,
+ "ratingValue" => $rating,
+ "ratingCount" => $num_ratings,
+ "reviewCount" => $num_ratings,
+ ],
+ "interactionStatistic" => [
+ "@type" => "InteractionCounter",
+ "interactionType" => "http://schema.org/DownloadAction",
+ "userInteractionCount" => self::get_downloads_count( $plugin ),
+ ],
+ "offers" => [
+ "@type" => "Offer",
+ "price" => "0.00",
+ "priceCurrency" => "USD",
+ "seller" => [
+ "@type" => "Organization",
+ "name" => "WordPress.org",
+ "url" => "https://wordpress.org"
+ ]
+ ]
+ ];
+ $schema[] = $software_application;
+
+ return $schema;
</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></pre>
</div>
</div>
</body>
</html>