<!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>[7758] sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook: Handbook plugin: Prevent children of unpublished pages from being included in sidebar page listing.</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/7758">7758</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/7758","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>coffee2code</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-10-22 22:55:17 +0000 (Mon, 22 Oct 2018)</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'>Handbook plugin: Prevent children of unpublished pages from being included in sidebar page listing.
Adds custom walker which is identical to `Walker_Page` except with a `walk()` that ignores orphaned children.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginshandbookhandbookphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/handbook.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginshandbookincwidgetsphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/widgets.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginshandbookincwalkerphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/walker.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginshandbookhandbookphp"></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/handbook/handbook.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/handbook/handbook.php 2018-10-22 17:43:33 UTC (rev 7757)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/handbook.php 2018-10-22 22:55:17 UTC (rev 7758)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -11,6 +11,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> require_once dirname( __FILE__ ) . '/inc/table-of-contents.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require_once dirname( __FILE__ ) . '/inc/template-tags.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require_once dirname( __FILE__ ) . '/inc/email-post-changes.php';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+require_once dirname( __FILE__ ) . '/inc/walker.php';
</ins><span class="cx" style="display: block; padding: 0 10px"> require_once dirname( __FILE__ ) . '/inc/watchlist.php';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> WPorg_Handbook_Glossary::init();
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginshandbookincwalkerphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/walker.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/handbook/inc/walker.php (rev 0)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/walker.php 2018-10-22 22:55:17 UTC (rev 7758)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,100 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Custom walker for widget page listing.
+ *
+ * Identical to `Walker_Page` except with a `walk()` that ignores orphaned
+ * pages, which are pages with an ancestor that is not published.
+ *
+ * @package handbook
+ */
+
+class WPorg_Handbook_Walker extends Walker_Page {
+
+ /**
+ * Display array of elements hierarchically.
+ *
+ * Does not assume any existing order of elements.
+ *
+ * $max_depth = -1 means flatly display every element.
+ * $max_depth = 0 means display all levels.
+ * $max_depth > 0 specifies the number of display levels.
+ *
+ * NOTE: This is identical to `Walker::walk()` except that it ignores orphaned
+ * pages, which are essentially pages whose ancestor is not published.
+ *
+ * @since 2.1.0
+ *
+ * @param array $elements An array of elements.
+ * @param int $max_depth The maximum hierarchical depth.
+ * @return string The hierarchical item output.
+ */
+ public function walk( $elements, $max_depth ) {
+ $args = array_slice( func_get_args(), 2 );
+ $output = '';
+
+ //invalid parameter or nothing to walk
+ if ( $max_depth < -1 || empty( $elements ) ) {
+ return $output;
+ }
+
+ $parent_field = $this->db_fields['parent'];
+
+ // flat display
+ if ( -1 == $max_depth ) {
+ $empty_array = array();
+ foreach ( $elements as $e ) {
+ $this->display_element( $e, $empty_array, 1, 0, $args, $output );
+ }
+ return $output;
+ }
+
+ /*
+ * Need to display in hierarchical order.
+ * Separate elements into two buckets: top level and children elements.
+ * Children_elements is two dimensional array, eg.
+ * Children_elements[10][] contains all sub-elements whose parent is 10.
+ */
+ $top_level_elements = array();
+ $children_elements = array();
+ foreach ( $elements as $e ) {
+ if ( empty( $e->$parent_field ) ) {
+ $top_level_elements[] = $e;
+ } else {
+ $children_elements[ $e->$parent_field ][] = $e;
+ }
+ }
+
+ /*
+ * When none of the elements is top level.
+ * Assume the first one must be root of the sub elements.
+ */
+ if ( empty( $top_level_elements ) ) {
+
+ $first = array_slice( $elements, 0, 1 );
+ $root = $first[0];
+
+ $top_level_elements = array();
+ $children_elements = array();
+ foreach ( $elements as $e ) {
+ if ( $root->$parent_field == $e->$parent_field ) {
+ $top_level_elements[] = $e;
+ } else {
+ $children_elements[ $e->$parent_field ][] = $e;
+ }
+ }
+ }
+
+ foreach ( $top_level_elements as $e ) {
+ $this->display_element( $e, $children_elements, $max_depth, 0, $args, $output );
+ }
+
+ /*
+ * Here is where it differs from the original `walk()`. The original would
+ * automatically display orphans.
+ */
+
+ return $output;
+ }
+
+}
+
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/walker.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginshandbookincwidgetsphp"></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/handbook/inc/widgets.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/handbook/inc/widgets.php 2018-10-22 17:43:33 UTC (rev 7757)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/widgets.php 2018-10-22 22:55:17 UTC (rev 7758)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -90,6 +90,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $args['exclude'] = rtrim( $page->ID . ',' . $args['exclude'], ',' );
</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">+ // Use custom walker that excludes display of orphaned pages. (An ancestor
+ // of such a page is likely not published and thus this is not accessible.)
+ $args['walker'] = new WPorg_Handbook_Walker;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $args;
</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>