<!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>[800] sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/handbook.php: Handbook plugin: add support for defining and retrieving custom handbook name</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 { 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">
<dt>Revision</dt> <dd><a href="http://meta.trac.wordpress.org/changeset/800">800</a></dd>
<dt>Author</dt> <dd>coffee2code</dd>
<dt>Date</dt> <dd>2014-08-19 17:34:26 +0000 (Tue, 19 Aug 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Handbook plugin: add support for defining and retrieving custom handbook name
* Add WPorg::get_name() to retrieve handbook name. Derives default if one isn't explicitly set.
* Add input for custom name via Settings -> General
See <a href="http://meta.trac.wordpress.org/ticket/439">#439</a></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>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginshandbookhandbookphp"></a>
<div class="modfile"><h4>Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/handbook.php (799 => 800)</h4>
<pre class="diff"><span>
<span class="info">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/handbook.php 2014-08-15 22:36:30 UTC (rev 799)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/handbook.php 2014-08-19 17:34:26 UTC (rev 800)
</span><span class="lines">@@ -37,6 +37,7 @@
</span><span class="cx"> class WPorg_Handbook {
</span><span class="cx">
</span><span class="cx"> public $post_type = '';
</span><ins>+ public $setting_name = '';
</ins><span class="cx">
</span><span class="cx"> protected $label = '';
</span><span class="cx">
</span><span class="lines">@@ -56,6 +57,38 @@
</span><span class="cx"> );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Returns the handbook name.
+ *
+ * If one isn't set via settings, one is generated.
+ *
+ * @param string $post_type Optional. Handbook post type.
+ * @param bool $raw Optional. Return only explicitly set name without attempting to generate default name?
+ * @return string
+ */
+ static function get_name( $post_type = 'handbook', $raw = false ) {
+ // Prefer explicitly configured handbook name.
+ $name = get_option( $post_type . '_name' );
+
+ // If handbook name isn't set, try root relative site path.
+ if ( ! $raw && empty( $name ) ) {
+ if ( is_multisite() ) {
+ $name = trim( get_blog_details()->path, '/' );
+ } else {
+ $name = trim( parse_url( get_option( 'home' ), PHP_URL_PATH ), '/' );
+ }
+
+ // If no name defined yet, try handbook post type if not standard.
+ if ( empty( $name ) && ( 'handbook' != $post_type ) ) {
+ $name = ucfirst( substr( $post_type, 0, -9 ) );
+ }
+
+ $name .= ' Handbook';
+ }
+
+ return trim( $name );
+ }
+
</ins><span class="cx"> function __construct( $type ) {
</span><span class="cx"> if ( 'handbook' != $type ) {
</span><span class="cx"> $this->post_type = $type . '-handbook';
</span><span class="lines">@@ -65,6 +98,8 @@
</span><span class="cx">
</span><span class="cx"> $this->label = ucwords( str_replace( array( '-', '_' ), ' ', $this->post_type ) );
</span><span class="cx">
</span><ins>+ $this->setting_name = $this->post_type . '_name';
+
</ins><span class="cx"> add_filter( 'user_has_cap', array( $this, 'grant_handbook_caps' ) );
</span><span class="cx"> add_filter( 'init', array( $this, 'register_post_type' ) );
</span><span class="cx"> add_action( 'admin_page_access_denied', array( $this, 'admin_page_access_denied' ) );
</span><span class="lines">@@ -73,8 +108,29 @@
</span><span class="cx"> add_action( 'widgets_init', array( $this, 'handbook_sidebar' ), 11 ); // After P2
</span><span class="cx"> add_action( 'wporg_email_changes_for_post_types', array( $this, 'wporg_email_changes_for_post_types' ) );
</span><span class="cx"> add_action( 'p2_action_links', array( $this, 'disable_p2_resolved_posts_action_links' ) );
</span><ins>+ add_action( 'admin_init', array( $this, 'add_name_setting' ) );
</ins><span class="cx"> }
</span><span class="cx">
</span><ins>+ function add_name_setting() {
+ register_setting( 'general', $this->setting_name, 'esc_attr' );
+
+ $label = ( 'handbook' == $this->post_type ) ?
+ __( 'Handbook name', 'wporg' ) :
+ sprintf( __( 'Handbook name (%s)', 'wporg' ), substr( $this->post_type, 0, -9 ) );
+
+ add_settings_field(
+ $this->setting_name,
+ '<label for="' . esc_attr( $this->setting_name ) . '">' . $label . '</label>',
+ array( $this, 'name_setting_html' ),
+ 'general'
+ );
+ }
+
+ function name_setting_html() {
+ $value = get_option( $this->setting_name, '' );
+ echo '<input type="text" id="' . esc_attr( $this->setting_name ) . '" name="' . esc_attr( $this->setting_name ) . '" value="' . esc_attr( $value ) . '" class="regular-text ltr" />';
+ }
+
</ins><span class="cx"> function grant_handbook_caps( $caps ) {
</span><span class="cx"> if ( ! is_user_member_of_blog() ) {
</span><span class="cx"> return $caps;
</span></span></pre>
</div>
</div>
</body>
</html>