<!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>[10752] sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/handbook.php: Handbooks, Handbook: Add missing function docblocks.</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/10752">10752</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/10752","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>2021-03-04 22:46:49 +0000 (Thu, 04 Mar 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'>Handbooks, Handbook: Add missing function docblocks.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginshandbookinchandbookphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/handbook.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginshandbookinchandbookphp"></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/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/inc/handbook.php 2021-03-04 22:43:04 UTC (rev 10751)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/handbook.php 2021-03-04 22:46:49 UTC (rev 10752)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7,11 +7,32 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> class WPorg_Handbook {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * The handbook post type.
+ *
+ * @var string
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public $post_type = '';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * The name of the setting for the handbook's name.
+ *
+ * @var string
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public $setting_name = '';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * The memoized and filtered label text for the handbook.
+ *
+ * @var string
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> protected $label = '';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Returns the custom handbook-related capabilities granted to site users.
+ *
+ * @return array
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public static function caps() {
</span><span class="cx" style="display: block; padding: 0 10px"> return [
</span><span class="cx" style="display: block; padding: 0 10px"> 'edit_handbook_pages',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -20,6 +41,11 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Returns the custom capabilities granted to handbook editors.
+ *
+ * @return array
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public static function editor_caps() {
</span><span class="cx" style="display: block; padding: 0 10px"> return [
</span><span class="cx" style="display: block; padding: 0 10px"> 'publish_handbook_pages',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -64,6 +90,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return trim( $name );
</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">+ /**
+ * Constructor
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function __construct( $type ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'handbook' !== $type ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->post_type = $type . '-handbook';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -153,6 +182,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $classes;
</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">+ /**
+ * Adds the setting for the handbook's name.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function add_name_setting() {
</span><span class="cx" style="display: block; padding: 0 10px"> register_setting( 'general', $this->setting_name, 'esc_attr' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -168,11 +200,19 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Outputs the HTML for the input field for the handbook's name.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function name_setting_html() {
</span><span class="cx" style="display: block; padding: 0 10px"> $value = get_option( $this->setting_name, '' );
</span><span class="cx" style="display: block; padding: 0 10px"> echo '<input type="text" id="' . esc_attr( $this->setting_name ) . '" name="' . esc_attr( $this->setting_name ) . '" value="' . esc_attr( $value ) . '" class="regular-text ltr" />';
</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">+ /**
+ * Grants handbook caps to the current user.
+ *
+ * @return array
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function grant_handbook_caps( $caps ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_user_member_of_blog() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $caps;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -191,6 +231,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $caps;
</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">+ /**
+ * Registers handbook post types.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function register_post_type() {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'handbook' != $this->post_type ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $slug = substr( $this->post_type, 0, -9 );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -344,6 +387,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $template;
</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">+ /**
+ * Performs query object adjustments for handbook requests prior to querying
+ * for posts.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function pre_get_posts( $query ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Bail early if query is not for this handbook's post type.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( get_query_var( 'post_type' ) !== $this->post_type ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -383,6 +430,9 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Registers sidebar and widgets for handbook pages.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function handbook_sidebar() {
</span><span class="cx" style="display: block; padding: 0 10px"> $sidebar_args = [
</span><span class="cx" style="display: block; padding: 0 10px"> 'id' => $this->post_type,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -402,6 +452,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> register_widget( 'WPorg_Handbook_Pages_Widget' );
</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">+ /**
+ * Amends list of post types for which users can opt into receiving emails
+ * about changes.
+ *
+ * @param array $post_types Post types.
+ * @return array
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function wporg_email_changes_for_post_types( $post_types ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! in_array( $this->post_type, $post_types ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $post_types[] = $this->post_type;
</span></span></pre>
</div>
</div>
</body>
</html>