<!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][7402] trunk/bp-activity/bp-activity-screens.php: Improve inline docs for bp-activity-screens.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/7402">7402</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2013-10-08 20:58:22 +0000 (Tue, 08 Oct 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Improve inline docs for bp-activity-screens.php</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpactivitybpactivityscreensphp">trunk/bp-activity/bp-activity-screens.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpactivitybpactivityscreensphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-activity/bp-activity-screens.php (7401 => 7402)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-activity/bp-activity-screens.php 2013-10-08 20:58:13 UTC (rev 7401)
+++ trunk/bp-activity/bp-activity-screens.php 2013-10-08 20:58:22 UTC (rev 7402)
</span><span class="lines">@@ -1,8 +1,12 @@
</span><span class="cx"> <?php
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * BuddyPress Activity Screens
</del><ins>+ * BuddyPress Activity Screens.
</ins><span class="cx"> *
</span><ins>+ * The functions in this file detect, with each page load, whether an Activity
+ * component page is being requested. If so, it parses any necessary data from
+ * the URL, and tells BuddyPress to load the appropriate template.
+ *
</ins><span class="cx"> * @package BuddyPress
</span><span class="cx"> * @subpackage ActivityScreens
</span><span class="cx"> */
</span><span class="lines">@@ -11,7 +15,7 @@
</span><span class="cx"> if ( !defined( 'ABSPATH' ) ) exit;
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Activity screen index
</del><ins>+ * Load the Activity directory.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.5)
</span><span class="cx"> *
</span><span class="lines">@@ -19,9 +23,9 @@
</span><span class="cx"> * @uses bp_is_activity_component()
</span><span class="cx"> * @uses bp_current_action()
</span><span class="cx"> * @uses bp_update_is_directory()
</span><del>- * @uses do_action() To call the 'bp_activity_screen_index' hook
</del><ins>+ * @uses do_action() To call the 'bp_activity_screen_index' hook.
</ins><span class="cx"> * @uses bp_core_load_template()
</span><del>- * @uses apply_filters() To call the 'bp_activity_screen_index' hook
</del><ins>+ * @uses apply_filters() To call the 'bp_activity_screen_index' hook.
</ins><span class="cx"> */
</span><span class="cx"> function bp_activity_screen_index() {
</span><span class="cx"> if ( !bp_displayed_user_id() && bp_is_activity_component() && !bp_current_action() ) {
</span><span class="lines">@@ -35,13 +39,13 @@
</span><span class="cx"> add_action( 'bp_screens', 'bp_activity_screen_index' );
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Activity screen 'my activity' index
</del><ins>+ * Load the 'My Activity' page.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.0)
</span><span class="cx"> *
</span><del>- * @uses do_action() To call the 'bp_activity_screen_my_activity' hook
</del><ins>+ * @uses do_action() To call the 'bp_activity_screen_my_activity' hook.
</ins><span class="cx"> * @uses bp_core_load_template()
</span><del>- * @uses apply_filters() To call the 'bp_activity_template_my_activity' hook
</del><ins>+ * @uses apply_filters() To call the 'bp_activity_template_my_activity' hook.
</ins><span class="cx"> */
</span><span class="cx"> function bp_activity_screen_my_activity() {
</span><span class="cx"> do_action( 'bp_activity_screen_my_activity' );
</span><span class="lines">@@ -49,16 +53,16 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Activity screen 'friends' index
</del><ins>+ * Load the 'My Friends' activity page.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.0)
</span><span class="cx"> *
</span><span class="cx"> * @uses bp_is_active()
</span><span class="cx"> * @uses bp_update_is_item_admin()
</span><span class="cx"> * @uses bp_current_user_can()
</span><del>- * @uses do_action() To call the 'bp_activity_screen_friends' hook
</del><ins>+ * @uses do_action() To call the 'bp_activity_screen_friends' hook.
</ins><span class="cx"> * @uses bp_core_load_template()
</span><del>- * @uses apply_filters() To call the 'bp_activity_template_friends_activity' hook
</del><ins>+ * @uses apply_filters() To call the 'bp_activity_template_friends_activity' hook.
</ins><span class="cx"> */
</span><span class="cx"> function bp_activity_screen_friends() {
</span><span class="cx"> if ( !bp_is_active( 'friends' ) )
</span><span class="lines">@@ -70,7 +74,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Activity screen 'groups' index
</del><ins>+ * Load the 'My Groups' activity page.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.2)
</span><span class="cx"> *
</span><span class="lines">@@ -91,7 +95,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Activity screen 'favorites' index
</del><ins>+ * Load the 'Favorites' activity page.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.2)
</span><span class="cx"> *
</span><span class="lines">@@ -108,7 +112,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Activity screen 'mentions' index
</del><ins>+ * Load the 'Mentions' activity page.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.2)
</span><span class="cx"> *
</span><span class="lines">@@ -125,8 +129,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Removes activity notifications from the notification menu when a user clicks on them and
- * is taken to a specific screen.
</del><ins>+ * Remove activity notifications when a user clicks on them.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.5)
</span><span class="cx"> *
</span><span class="lines">@@ -143,7 +146,7 @@
</span><span class="cx"> add_action( 'bp_activity_screen_mentions', 'bp_activity_remove_screen_notifications' );
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Reset the logged-in user's new mentions data when he visits his mentions screen
</del><ins>+ * Reset the logged-in user's new mentions data when he visits his mentions screen.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.5)
</span><span class="cx"> *
</span><span class="lines">@@ -158,7 +161,7 @@
</span><span class="cx"> add_action( 'bp_activity_screen_mentions', 'bp_activity_reset_my_new_mentions' );
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Reset the logged-in user's new mentions data when he visits his mentions screen
</del><ins>+ * Load the page for a single activity item.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.2)
</span><span class="cx"> *
</span><span class="lines">@@ -255,13 +258,13 @@
</span><span class="cx"> add_action( 'bp_screens', 'bp_activity_screen_single_activity_permalink' );
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Add activity notifications settings to the notifications settings page
</del><ins>+ * Add activity notifications settings to the notifications settings page.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.2)
</span><span class="cx"> *
</span><span class="cx"> * @uses bp_get_user_meta()
</span><span class="cx"> * @uses bp_core_get_username()
</span><del>- * @uses do_action() To call the 'bp_activity_screen_notification_settings' hook
</del><ins>+ * @uses do_action() To call the 'bp_activity_screen_notification_settings' hook.
</ins><span class="cx"> */
</span><span class="cx"> function bp_activity_screen_notification_settings() {
</span><span class="cx">
</span><span class="lines">@@ -315,7 +318,7 @@
</span><span class="cx"> /** Theme Compatability *******************************************************/
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * The main theme compat class for BuddyPress Activity
</del><ins>+ * The main theme compat class for BuddyPress Activity.
</ins><span class="cx"> *
</span><span class="cx"> * This class sets up the necessary theme compatability actions to safely output
</span><span class="cx"> * activity template parts to the_title and the_content areas of a theme.
</span><span class="lines">@@ -325,7 +328,7 @@
</span><span class="cx"> class BP_Activity_Theme_Compat {
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Setup the activity component theme compatibility
</del><ins>+ * Set up the activity component theme compatibility.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.7)
</span><span class="cx"> */
</span><span class="lines">@@ -334,7 +337,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Are we looking at something that needs activity theme compatability?
</del><ins>+ * Set up the theme compatibility hooks, if we're looking at an activity page.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.7)
</span><span class="cx"> */
</span><span class="lines">@@ -371,7 +374,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.8)
</span><span class="cx"> *
</span><del>- * @param string $templates The templates from bp_get_theme_compat_templates()
</del><ins>+ * @param string $templates The templates from bp_get_theme_compat_templates().
</ins><span class="cx"> * @return array $templates Array of custom templates to look for.
</span><span class="cx"> */
</span><span class="cx"> public function directory_template_hierarchy( $templates ) {
</span><span class="lines">@@ -388,7 +391,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Update the global $post with directory data
</del><ins>+ * Update the global $post with directory data.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.7)
</span><span class="cx"> */
</span><span class="lines">@@ -407,7 +410,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Filter the_content with the groups index template part
</del><ins>+ * Filter the_content with the groups index template part.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.7)
</span><span class="cx"> */
</span><span class="lines">@@ -424,7 +427,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.8)
</span><span class="cx"> *
</span><del>- * @param string $templates The templates from bp_get_theme_compat_templates()
</del><ins>+ * @param string $templates The templates from bp_get_theme_compat_templates().
</ins><span class="cx"> * @return array $templates Array of custom templates to look for.
</span><span class="cx"> */
</span><span class="cx"> public function single_template_hierarchy( $templates ) {
</span><span class="lines">@@ -441,7 +444,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Update the global $post with the displayed user's data
</del><ins>+ * Update the global $post with the displayed user's data.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.7)
</span><span class="cx"> */
</span><span class="lines">@@ -460,7 +463,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Filter the_content with the members' activity permalink template part
</del><ins>+ * Filter the_content with the members' activity permalink template part.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.7)
</span><span class="cx"> */
</span></span></pre>
</div>
</div>
</body>
</html>