<!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>[3234] sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook: Handbook plugin: Add four template tags relating to handbook pages.</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" 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/3234">3234</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/3234","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>2016-05-24 21:02:25 +0000 (Tue, 24 May 2016)</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: Add four template tags relating to handbook pages.
Specifically: `wporg_get_handbook_post_types()`, `wporg_is_handbook()`, `wporg_is_handbook_post_type()`, and `wporg_get_current_handbook()`.
Props keesiemeijer.
See <a href="http://meta.trac.wordpress.org/ticket/515">#515</a>, <a href="http://meta.trac.wordpress.org/ticket/1671">#1671</a>.
Fixes <a href="http://meta.trac.wordpress.org/ticket/1693">#1693</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>
<h3>Added Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginshandbookinctemplatetagsphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/template-tags.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 2016-05-24 20:55:22 UTC (rev 3233)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/handbook.php 2016-05-24 21:02:25 UTC (rev 3234)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -9,6 +9,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> require_once dirname( __FILE__ ) . '/inc/glossary.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require_once dirname( __FILE__ ) . '/inc/navigation.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require_once dirname( __FILE__ ) . '/inc/table-of-contents.php';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+require_once dirname( __FILE__ ) . '/inc/template-tags.php';
</ins><span class="cx" style="display: block; padding: 0 10px"> require_once dirname( __FILE__ ) . '/inc/email-post-changes.php';
</span><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></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginshandbookinctemplatetagsphp"></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/template-tags.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/template-tags.php (rev 0)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/template-tags.php 2016-05-24 21:02:25 UTC (rev 3234)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,80 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * Gets a list of all registered hand book post types.
+ *
+ * Wrapper function for WPorg_Handbook_Init::get_post_types().
+ *
+ * @return array Array with full handbook post type names {post-type}-handbook.
+ */
+function wporg_get_handbook_post_types() {
+ if ( ! class_exists( 'WPorg_Handbook_Init' ) ) {
+ return array();
+ }
+
+ $post_types = WPorg_Handbook_Init::get_post_types();
+
+ foreach ( $post_types as $key => $post_type ) {
+ if ( 'handbook' !== $post_type ) {
+ $post_types[ $key ] = $post_type . '-handbook';
+ }
+ }
+
+ return $post_types;
+}
+
+/**
+ * Is the query for an existing handbook page?
+ *
+ * @param string $handbook Handbook post type.
+ * @return bool Whether the query is for an existing handbook page. Returns true on handbook pages.
+ */
+function wporg_is_handbook( $handbook = '' ) {
+ $post_types = wporg_get_handbook_post_types();
+
+ if ( is_admin() || ! $post_types ) {
+ return false;
+ }
+
+ foreach ( $post_types as $post_type ) {
+ $is_handbook = ! $handbook || ( $handbook === $post_type );
+ $handbook_query = is_singular( $post_type ) || is_post_type_archive( $post_type );
+
+ if ( $is_handbook && $handbook_query ) {
+ return true;
+ }
+ }
+
+ return false;
+}
+
+/**
+ * Is the current (or specified) post_type a handbook post type?
+ *
+ * @param string $post_type Optional. The post_type to check for being a handbook post type. Default '' (the current post type).
+ * @return bool
+ */
+function wporg_is_handbook_post_type( $post_type = '' ) {
+ if ( ! $post_type ) {
+ $post_type = get_post_type();
+ }
+
+ return in_array( $post_type, wporg_get_handbook_post_types() );
+}
+
+/**
+ * Returns the current handbook post type.
+ *
+ * @return string|false Post type on success, false on failure.
+ */
+function wporg_get_current_handbook() {
+ $handbooks = wporg_get_handbook_post_types();
+
+ foreach ( $handbooks as $handbook ) {
+ if ( wporg_is_handbook( $handbook ) ) {
+ return $handbook;
+ }
+ }
+
+ return false;
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/template-tags.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></div>
</body>
</html>