<!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>[11217] sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-openverse: Openverse: Update the theme to pass the locale.</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/11217">11217</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/11217","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>2021-09-08 01:07:57 +0000 (Wed, 08 Sep 2021)</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'>Openverse: Update the theme to pass the locale.
Fixes <a href="http://meta.trac.wordpress.org/ticket/5892">#5892</a>.
Closes https://github.com/WordPress/wordpress.org/pull/39</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgopenversefunctionsphp">sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-openverse/functions.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgopenverseindexphp">sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-openverse/index.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgopenversejsmessagejs">sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-openverse/js/message.js</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgopenversejsmessage_testhtml">sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-openverse/js/message_test.html</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgopenversefunctionsphp"></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/themes/pub/wporg-openverse/functions.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/themes/pub/wporg-openverse/functions.php 2021-08-31 19:50:20 UTC (rev 11216)
+++ sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-openverse/functions.php 2021-09-08 01:07:57 UTC (rev 11217)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -85,8 +85,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_add_inline_script(
</span><span class="cx" style="display: block; padding: 0 10px"> /* handle */ 'openverse-message',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /* JS */ 'const openverseUrl = ' . json_encode( get_theme_mod( 'ov_src_url', OPENVERSE_URL ) ) . ";\n" .
- /* JS */ 'const openverseSubpath = ' . json_encode( OPENVERSE_SUBPATH ) . ";\n",
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /* JS */ 'const openverseUrl = ' . wp_json_encode( get_theme_mod( 'ov_src_url', OPENVERSE_URL ) ) . ";\n" .
+ /* JS */ 'const openverseSubpath = ' . wp_json_encode( OPENVERSE_SUBPATH ) . ";\n" .
+ /* JS */ 'const currentLocale = ' . wp_json_encode( get_locale() ) . ";\n",
</ins><span class="cx" style="display: block; padding: 0 10px"> /* position */ 'before'
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgopenverseindexphp"></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/themes/pub/wporg-openverse/index.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/themes/pub/wporg-openverse/index.php 2021-08-31 19:50:20 UTC (rev 11216)
+++ sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-openverse/index.php 2021-09-08 01:07:57 UTC (rev 11217)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -19,7 +19,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <main id="main" class="site-main" role="main">
</span><span class="cx" style="display: block; padding: 0 10px"> <iframe id="openverse_embed">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 😢 Your browser does not support inline frames.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 😢 Your browser does not support inline frames.
</ins><span class="cx" style="display: block; padding: 0 10px"> </iframe>
</span><span class="cx" style="display: block; padding: 0 10px"> </main><!-- #main -->
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgopenversejsmessagejs"></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/themes/pub/wporg-openverse/js/message.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-openverse/js/message.js 2021-08-31 19:50:20 UTC (rev 11216)
+++ sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-openverse/js/message.js 2021-09-08 01:07:57 UTC (rev 11217)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6,17 +6,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param {{ height: number }} value - the new dimensions of the iframe
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function updateHeight(value) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- const height = value.height;
- let heightProp
- if (height) {
- heightProp = `${height}px`;
- } else {
- heightProp = '100vh';
- }
- document
- .documentElement
- .style
- .setProperty('--openverse-embed-height', heightProp);
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ const height = value.height;
+ let heightProp;
+ if (height) {
+ heightProp = `${height}px`;
+ } else {
+ heightProp = '100vh';
+ }
+ document
+ .documentElement
+ .style
+ .setProperty('--openverse-embed-height', heightProp);
</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="lines" style="display: block; padding: 0 10px; color: #888">@@ -31,28 +31,51 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * }} value - the attributes of the new history state
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function updatePath(value) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- const path = value.path;
- const url = `${openverseSubpath}${path}`; // openverseSubpath defined in `index.php`
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ const path = value.path;
+ const url = `${openverseSubpath}${path}`; // openverseSubpath defined in `index.php`
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- console.log(`Replacing state URL: ${url}`);
- history.replaceState(
- value.state,
- value.title ?? 'Openverse',
- url,
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ console.log(`Replacing state URL: ${url}`);
+ history.replaceState(
+ value.state,
+ value.title ?? 'Openverse',
+ url,
+ );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if (value.title) {
- console.log(`Setting document title: ${value.title}`);
- document.title = value.title;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if (value.title) {
+ console.log(`Setting document title: ${value.title}`);
+ document.title = value.title;
+ }
</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">+ * Emit a message to the `iframe` containing information about the current
+ * locale. This function combines the locale from WordPress with attributes
+ * from the top-level HTML document.
+ */
+function emitLocale() {
+ const currentLang = document.documentElement.lang;
+ const currentDir = document.documentElement.dir;
+
+ const iframe = document.getElementById('openverse_embed');
+ iframe.contentWindow.postMessage(
+ {
+ type: 'localeSet',
+ value: {
+ dir: currentDir,
+ lang: currentLang,
+ locale: currentLocale, // set in `header.php`
+ },
+ },
+ '*', // Bad practice, but we are not sending sensitive info
+ );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * This is the default handler for all messages received in this frame that do
</span><span class="cx" style="display: block; padding: 0 10px"> * not have a handler configured for them.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function logUnhandled() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- console.error('No handler configured for event received');
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ console.error('No handler configured for event received');
</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="lines" style="display: block; padding: 0 10px; color: #888">@@ -64,24 +87,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * value: any,
</span><span class="cx" style="display: block; padding: 0 10px"> * }>} message - the message object sent to this document
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function handleIframeMessages ({ origin, data }) {
- if (data.debug) {
- console.log(`Received message from origin ${origin}:`);
- console.log(data);
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function handleIframeMessages({ origin, data }) {
+ if (data.debug) {
+ console.log(`Received message from origin ${origin}:`);
+ console.log(data);
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- let handler
- switch(data.type) {
- case 'resize':
- handler = updateHeight;
- break;
- case 'urlChange':
- handler = updatePath;
- break;
- default:
- handler = logUnhandled;
- }
- handler(data.value);
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ let handler;
+ switch (data.type) {
+ case 'resize':
+ handler = updateHeight;
+ break;
+ case 'urlChange':
+ handler = updatePath;
+ break;
+ case 'localeGet':
+ handler = emitLocale;
+ break;
+ default:
+ handler = logUnhandled;
+ }
+ handler(data.value);
</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"> window.addEventListener('message', handleIframeMessages);
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgopenversejsmessage_testhtml"></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/themes/pub/wporg-openverse/js/message_test.html</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-openverse/js/message_test.html 2021-08-31 19:50:20 UTC (rev 11216)
+++ sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-openverse/js/message_test.html 2021-09-08 01:07:57 UTC (rev 11217)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7,6 +7,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> .row:not(:first-of-type) {
</span><span class="cx" style="display: block; padding: 0 10px"> margin-top: 1em;
</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"> label {
</span><span class="cx" style="display: block; padding: 0 10px"> display: inline-block;
</span><span class="cx" style="display: block; padding: 0 10px"> width: 5em;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -19,7 +20,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param {string} type - the type of the message being sent to the parent
</span><span class="cx" style="display: block; padding: 0 10px"> * @param {any} value - the data to send along with the message
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function sendMessage (type, value) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function sendMessage(type, value = {}) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if (window.parent !== window) {
</span><span class="cx" style="display: block; padding: 0 10px"> const message = { debug: true, type, value };
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -64,6 +65,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> sendMessage('urlChange', message);
</span><span class="cx" style="display: block; padding: 0 10px"> });
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ document.forms.localeGet.addEventListener('submit', (event) => {
+ event.preventDefault();
+
+ const listener = ({ origin, data }) => {
+ if (data.type !== 'localeSet') {
+ return;
+ }
+
+ console.log(`Received message from origin ${origin}:`);
+ document.getElementById('gotLocale').innerText = JSON.stringify(data, null, 2);
+
+ console.log('Removing listener');
+ window.removeEventListener('message', listener);
+ };
+ window.addEventListener('message', listener);
+ sendMessage('localeGet');
+ });
</ins><span class="cx" style="display: block; padding: 0 10px"> });
</span><span class="cx" style="display: block; padding: 0 10px"> </script>
</span><span class="cx" style="display: block; padding: 0 10px"> </head>
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -113,5 +132,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> </button>
</span><span class="cx" style="display: block; padding: 0 10px"> </div>
</span><span class="cx" style="display: block; padding: 0 10px"> </form>
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ <h2>Test locale get</h2>
+ <form name="localeGet">
+ <div class="row">
+ <button type="submit">
+ Get locale
+ </button>
+ <pre><code id="gotLocale"></code></pre>
+ </div>
+ </form>
</ins><span class="cx" style="display: block; padding: 0 10px"> </body>
</span><span class="cx" style="display: block; padding: 0 10px"> </html>
</span></span></pre>
</div>
</div>
</body>
</html>