<!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>[BuddyPress][7399] trunk/bp-core/bp-core-component.php: Improve inline docs in bp-core-component.php.</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://buddypress.trac.wordpress.org/changeset/7399">7399</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2013-10-08 20:58:05 +0000 (Tue, 08 Oct 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Improve inline docs in bp-core-component.php.
See <a href="http://buddypress.trac.wordpress.org/ticket/5022">#5022</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpcorebpcorecomponentphp">trunk/bp-core/bp-core-component.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpcorebpcorecomponentphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-core/bp-core-component.php (7398 => 7399)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-core/bp-core-component.php 2013-10-08 20:58:00 UTC (rev 7398)
+++ trunk/bp-core/bp-core-component.php 2013-10-08 20:58:05 UTC (rev 7399)
</span><span class="lines">@@ -118,14 +118,34 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Component global variables
</del><ins>+ * Set up component global variables.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.5)
</span><span class="cx"> *
</span><del>- * @uses apply_filters() Calls 'bp_{@link bp_Component::name}_id'
- * @uses apply_filters() Calls 'bp_{@link bp_Component::name}_slug'
</del><ins>+ * @uses apply_filters() Calls 'bp_{@link bp_Component::name}_id'.
+ * @uses apply_filters() Calls 'bp_{@link bp_Component::name}_slug'.
</ins><span class="cx"> *
</span><del>- * @param array $args Optional
</del><ins>+ * @param array $args {
+ * All values are optional.
+ * @type string $slug The component slug. Used to construct certain
+ * URLs, such as 'friends' in
+ * http://example.com/members/joe/friends/
+ * @type string $root_slug The component root slug. Note that this
+ * value is generally unused if the component
+ * has a root directory (the slug will be
+ * overridden by the post_name of the
+ * directory page).
+ * @type bool $has_directory Set to true if the component requires
+ * an associated WordPress page.
+ * @type string $notification_callback The callable function that
+ * formats the component's
+ * notifications.
+ * @type string $search_term Optional. The placeholder text in the
+ * component directory search box. Eg,
+ * 'Search Groups...'.
+ * @type array $global_tables Optional. An array of database table
+ * names.
+ * }
</ins><span class="cx"> */
</span><span class="cx"> public function setup_globals( $args = array() ) {
</span><span class="cx">
</span><span class="lines">@@ -199,6 +219,9 @@
</span><span class="cx"> * @since BuddyPress (1.5)
</span><span class="cx"> *
</span><span class="cx"> * @uses do_action() Calls 'bp_{@link bp_Component::name}includes'
</span><ins>+ *
+ * @param array $includes An array of file names, or file name chunks,
+ * to be parsed and then included.
</ins><span class="cx"> */
</span><span class="cx"> public function includes( $includes = array() ) {
</span><span class="cx">
</span><span class="lines">@@ -291,10 +314,19 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Setup the navigation
</del><ins>+ * Set up component navigation.
</ins><span class="cx"> *
</span><del>- * @param array $main_nav Optional
- * @param array $sub_nav Optional
</del><ins>+ * @see bp_core_new_nav_item() For a description of the $main_nav
+ * parameter formatting.
+ * @see bp_core_new_subnav_item() For a description of how each item
+ * in the $sub_nav parameter array should be formatted.
+ *
+ * @param array $main_nav Optional. Passed directly to
+ * bp_core_new_nav_item(). See that function for
+ * a description.
+ * @param array $sub_nav Optional. Multidimensional array, each item in
+ * which is passed to bp_core_new_subnav_item().
+ * See that function for a description.
</ins><span class="cx"> */
</span><span class="cx"> public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
</span><span class="cx">
</span><span class="lines">@@ -315,10 +347,17 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Setup the Toolbar
</del><ins>+ * Set up the component entries in the WordPress Admin Bar.
</ins><span class="cx"> *
</span><ins>+ * @see WP_Admin_Bar::add_menu() for a description of the syntax
+ * required by each item in the $wp_admin_nav parameter array.
</ins><span class="cx"> * @global obj $wp_admin_bar
</span><del>- * @param array $wp_admin_menus
</del><ins>+ *
+ * @param array $wp_admin_nav An array of nav item arguments. Each item
+ * in this parameter array is passed to
+ * WP_Admin_Bar::add_menu(). See that method
+ * for a description of the required syntax
+ * for each item.
</ins><span class="cx"> */
</span><span class="cx"> public function setup_admin_bar( $wp_admin_nav = array() ) {
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>