<!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][7433] trunk/bp-core: Improve inline docs in bp-core.</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/7433">7433</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2013-10-16 13:36:51 +0000 (Wed, 16 Oct 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Improve inline docs in bp-core. See <a href="http://buddypress.trac.wordpress.org/ticket/5022">#5022</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpcorebpcoreactionsphp">trunk/bp-core/bp-core-actions.php</a></li>
<li><a href="#trunkbpcorebpcoreadminphp">trunk/bp-core/bp-core-admin.php</a></li>
<li><a href="#trunkbpcorebpcoreadminbarphp">trunk/bp-core/bp-core-adminbar.php</a></li>
<li><a href="#trunkbpcorebpcoreavatarsphp">trunk/bp-core/bp-core-avatars.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpcorebpcoreactionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-core/bp-core-actions.php (7432 => 7433)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-core/bp-core-actions.php 2013-10-16 00:52:42 UTC (rev 7432)
+++ trunk/bp-core/bp-core-actions.php 2013-10-16 13:36:51 UTC (rev 7433)
</span><span class="lines">@@ -1,7 +1,7 @@
</span><span class="cx"> <?php
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * BuddyPress Filters & Actions
</del><ins>+ * BuddyPress Filters & Actions.
</ins><span class="cx"> *
</span><span class="cx"> * @package BuddyPress
</span><span class="cx"> * @subpackage Hooks
</span><span class="lines">@@ -16,7 +16,7 @@
</span><span class="cx"> if ( !defined( 'ABSPATH' ) ) exit;
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Attach BuddyPress to WordPress
</del><ins>+ * Attach BuddyPress to WordPress.
</ins><span class="cx"> *
</span><span class="cx"> * BuddyPress uses its own internal actions to help aid in third-party plugin
</span><span class="cx"> * development, and to limit the amount of potential future code changes when
</span></span></pre></div>
<a id="trunkbpcorebpcoreadminphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-core/bp-core-admin.php (7432 => 7433)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-core/bp-core-admin.php 2013-10-16 00:52:42 UTC (rev 7432)
+++ trunk/bp-core/bp-core-admin.php 2013-10-16 13:36:51 UTC (rev 7433)
</span><span class="lines">@@ -1,7 +1,7 @@
</span><span class="cx"> <?php
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Main BuddyPress Admin Class
</del><ins>+ * Main BuddyPress Admin Class.
</ins><span class="cx"> *
</span><span class="cx"> * @package BuddyPress
</span><span class="cx"> * @subpackage CoreAdministration
</span><span class="lines">@@ -12,53 +12,64 @@
</span><span class="cx">
</span><span class="cx"> if ( !class_exists( 'BP_Admin' ) ) :
</span><span class="cx"> /**
</span><del>- * Loads BuddyPress plugin admin area
</del><ins>+ * Load BuddyPress plugin admin area.
</ins><span class="cx"> *
</span><span class="cx"> * @package BuddyPress
</span><span class="cx"> * @subpackage CoreAdministration
</span><del>- * @since BuddyPress (1.6)
</del><ins>+ *
+ * @since BuddyPress (1.6.0)
</ins><span class="cx"> */
</span><span class="cx"> class BP_Admin {
</span><span class="cx">
</span><span class="cx"> /** Directory *************************************************************/
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * @var string Path to the BuddyPress admin directory
</del><ins>+ * Path to the BuddyPress admin directory.
+ *
+ * @var string $admin_dir
</ins><span class="cx"> */
</span><span class="cx"> public $admin_dir = '';
</span><span class="cx">
</span><span class="cx"> /** URLs ******************************************************************/
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * @var string URL to the BuddyPress admin directory
</del><ins>+ * URL to the BuddyPress admin directory.
+ *
+ * @var string $admin_url
</ins><span class="cx"> */
</span><span class="cx"> public $admin_url = '';
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * @var string URL to the BuddyPress images directory
</del><ins>+ * URL to the BuddyPress images directory.
+ *
+ * @var string $images_url
</ins><span class="cx"> */
</span><span class="cx"> public $images_url = '';
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * @var string URL to the BuddyPress admin CSS directory
</del><ins>+ * URL to the BuddyPress admin CSS directory.
+ *
+ * @var string $css_url
</ins><span class="cx"> */
</span><span class="cx"> public $css_url = '';
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * @var string URL to the BuddyPress admin JS directory
</del><ins>+ * URL to the BuddyPress admin JS directory.
+ *
+ * @var string
</ins><span class="cx"> */
</span><span class="cx"> public $js_url = '';
</span><span class="cx">
</span><span class="cx"> /** Methods ***************************************************************/
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * The main BuddyPress admin loader
</del><ins>+ * The main BuddyPress admin loader.
</ins><span class="cx"> *
</span><del>- * @since BuddyPress (1.6)
</del><ins>+ * @since BuddyPress (1.6.0)
</ins><span class="cx"> *
</span><del>- * @uses BP_Admin::setup_globals() Setup the globals needed
- * @uses BP_Admin::includes() Include the required files
- * @uses BP_Admin::setup_actions() Setup the hooks and actions
</del><ins>+ * @uses BP_Admin::setup_globals() Setup the globals needed.
+ * @uses BP_Admin::includes() Include the required files.
+ * @uses BP_Admin::setup_actions() Setup the hooks and actions.
</ins><span class="cx"> */
</span><span class="cx"> public function __construct() {
</span><span class="cx"> $this->setup_globals();
</span><span class="lines">@@ -67,10 +78,10 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Admin globals
</del><ins>+ * Set admin-related globals.
</ins><span class="cx"> *
</span><del>- * @since BuddyPress (1.6)
</del><span class="cx"> * @access private
</span><ins>+ * @since BuddyPress (1.6.0)
</ins><span class="cx"> */
</span><span class="cx"> private function setup_globals() {
</span><span class="cx"> $bp = buddypress();
</span><span class="lines">@@ -87,9 +98,9 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Include required files
</del><ins>+ * Include required files.
</ins><span class="cx"> *
</span><del>- * @since BuddyPress (1.6)
</del><ins>+ * @since BuddyPress (1.6.0)
</ins><span class="cx"> * @access private
</span><span class="cx"> */
</span><span class="cx"> private function includes() {
</span><span class="lines">@@ -101,13 +112,13 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Setup the admin hooks, actions and filters
</del><ins>+ * Set up the admin hooks, actions, and filters.
</ins><span class="cx"> *
</span><del>- * @since BuddyPress (1.6)
</del><span class="cx"> * @access private
</span><ins>+ * @since BuddyPress (1.6.0)
</ins><span class="cx"> *
</span><del>- * @uses add_action() To add various actions
- * @uses add_filter() To add various filters
</del><ins>+ * @uses add_action() To add various actions.
+ * @uses add_filter() To add various filters.
</ins><span class="cx"> */
</span><span class="cx"> private function setup_actions() {
</span><span class="cx">
</span><span class="lines">@@ -138,13 +149,13 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Add the navigational menu elements
</del><ins>+ * Add the navigational menu elements.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.6)
</span><span class="cx"> *
</span><del>- * @uses add_management_page() To add the Recount page in Tools section
</del><ins>+ * @uses add_management_page() To add the Recount page in Tools section.
</ins><span class="cx"> * @uses add_options_page() To add the Forums settings page in Settings
</span><del>- * section
</del><ins>+ * section.
</ins><span class="cx"> */
</span><span class="cx"> public function admin_menus() {
</span><span class="cx">
</span><span class="lines">@@ -226,13 +237,13 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Register the settings
</del><ins>+ * Register the settings.
</ins><span class="cx"> *
</span><del>- * @since BuddyPress (1.6)
</del><ins>+ * @since BuddyPress (1.6.0)
</ins><span class="cx"> *
</span><del>- * @uses add_settings_section() To add our own settings section
- * @uses add_settings_field() To add various settings fields
- * @uses register_setting() To register various settings
</del><ins>+ * @uses add_settings_section() To add our own settings section.
+ * @uses add_settings_field() To add various settings fields.
+ * @uses register_setting() To register various settings.
</ins><span class="cx"> */
</span><span class="cx"> public function register_admin_settings() {
</span><span class="cx">
</span><span class="lines">@@ -315,13 +326,13 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Add Settings link to plugins area
</del><ins>+ * Add Settings link to plugins area.
</ins><span class="cx"> *
</span><del>- * @since BuddyPress (1.6)
</del><ins>+ * @since BuddyPress (1.6.0)
</ins><span class="cx"> *
</span><del>- * @param array $links Links array in which we would prepend our link
- * @param string $file Current plugin basename
- * @return array Processed links
</del><ins>+ * @param array $links Links array in which we would prepend our link.
+ * @param string $file Current plugin basename.
+ * @return array Processed links.
</ins><span class="cx"> */
</span><span class="cx"> public function modify_plugin_action_links( $links, $file ) {
</span><span class="cx">
</span><span class="lines">@@ -337,9 +348,9 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Add some general styling to the admin area
</del><ins>+ * Add some general styling to the admin area.
</ins><span class="cx"> *
</span><del>- * @since BuddyPress (1.6)
</del><ins>+ * @since BuddyPress (1.6.0)
</ins><span class="cx"> */
</span><span class="cx"> public function admin_head() {
</span><span class="cx">
</span><span class="lines">@@ -353,9 +364,9 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Add some general styling to the admin area
</del><ins>+ * Add some general styling to the admin area.
</ins><span class="cx"> *
</span><del>- * @since BuddyPress (1.6)
</del><ins>+ * @since BuddyPress (1.6.0)
</ins><span class="cx"> */
</span><span class="cx"> public function enqueue_scripts() {
</span><span class="cx">
</span><span class="lines">@@ -369,9 +380,9 @@
</span><span class="cx"> /** About *****************************************************************/
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Output the about screen
</del><ins>+ * Output the about screen.
</ins><span class="cx"> *
</span><del>- * @since BuddyPress (1.7)
</del><ins>+ * @since BuddyPress (1.7.0)
</ins><span class="cx"> */
</span><span class="cx"> public function about_screen() {
</span><span class="cx"> global $wp_rewrite;
</span><span class="lines">@@ -480,12 +491,12 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Output the credits screen
</del><ins>+ * Output the credits screen.
</ins><span class="cx"> *
</span><del>- * Hardcoding this in here is pretty janky. It's fine for 2.2, but we'll
</del><ins>+ * Hardcoding this in here is pretty janky. It's fine for now, but we'll
</ins><span class="cx"> * want to leverage api.wordpress.org eventually.
</span><span class="cx"> *
</span><del>- * @since BuddyPress (1.7)
</del><ins>+ * @since BuddyPress (1.7.0)
</ins><span class="cx"> */
</span><span class="cx"> public function credits_screen() {
</span><span class="cx">
</span><span class="lines">@@ -612,9 +623,9 @@
</span><span class="cx"> endif; // class_exists check
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Setup BuddyPress Admin
</del><ins>+ * Setup BuddyPress Admin.
</ins><span class="cx"> *
</span><del>- * @since BuddyPress (1.6)
</del><ins>+ * @since BuddyPress (1.6.0)
</ins><span class="cx"> *
</span><span class="cx"> * @uses BP_Admin
</span><span class="cx"> */
</span></span></pre></div>
<a id="trunkbpcorebpcoreadminbarphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-core/bp-core-adminbar.php (7432 => 7433)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-core/bp-core-adminbar.php 2013-10-16 00:52:42 UTC (rev 7432)
+++ trunk/bp-core/bp-core-adminbar.php 2013-10-16 13:36:51 UTC (rev 7433)
</span><span class="lines">@@ -1,9 +1,9 @@
</span><span class="cx"> <?php
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * BuddyPress Core Toolbar
</del><ins>+ * BuddyPress Core Toolbar.
</ins><span class="cx"> *
</span><del>- * Handles the core functions related to the WordPress Toolbar
</del><ins>+ * Handles the core functions related to the WordPress Toolbar.
</ins><span class="cx"> *
</span><span class="cx"> * @package BuddyPress
</span><span class="cx"> * @subpackage Core
</span><span class="lines">@@ -13,9 +13,10 @@
</span><span class="cx"> if ( !defined( 'ABSPATH' ) ) exit;
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Adds the secondary BuddyPress area to the my-account menu
</del><ins>+ * Add the secondary BuddyPress area to the my-account menu.
</ins><span class="cx"> *
</span><del>- * @since BuddyPress 1.6
</del><ins>+ * @since BuddyPress (1.6.0)
+ *
</ins><span class="cx"> * @global WP_Admin_Bar $wp_admin_bar
</span><span class="cx"> */
</span><span class="cx"> function bp_admin_bar_my_account_root() {
</span><span class="lines">@@ -43,22 +44,22 @@
</span><span class="cx"> add_action( 'admin_bar_menu', 'bp_admin_bar_my_account_root', 100 );
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Handle the Toolbar/BuddyBar business
</del><ins>+ * Handle the Toolbar/BuddyBar business.
</ins><span class="cx"> *
</span><del>- * @since BuddyPress (1.2)
</del><ins>+ * @since BuddyPress (1.2.0)
</ins><span class="cx"> *
</span><span class="cx"> * @global string $wp_version
</span><span class="cx"> * @uses bp_get_option()
</span><span class="cx"> * @uses is_user_logged_in()
</span><span class="cx"> * @uses bp_use_wp_admin_bar()
</span><span class="cx"> * @uses show_admin_bar()
</span><del>- * @uses add_action() To hook 'bp_adminbar_logo' to 'bp_adminbar_logo'
- * @uses add_action() To hook 'bp_adminbar_login_menu' to 'bp_adminbar_menus'
- * @uses add_action() To hook 'bp_adminbar_account_menu' to 'bp_adminbar_menus'
- * @uses add_action() To hook 'bp_adminbar_thisblog_menu' to 'bp_adminbar_menus'
- * @uses add_action() To hook 'bp_adminbar_random_menu' to 'bp_adminbar_menus'
- * @uses add_action() To hook 'bp_core_admin_bar' to 'wp_footer'
- * @uses add_action() To hook 'bp_core_admin_bar' to 'admin_footer'
</del><ins>+ * @uses add_action() To hook 'bp_adminbar_logo' to 'bp_adminbar_logo'.
+ * @uses add_action() To hook 'bp_adminbar_login_menu' to 'bp_adminbar_menus'.
+ * @uses add_action() To hook 'bp_adminbar_account_menu' to 'bp_adminbar_menus'.
+ * @uses add_action() To hook 'bp_adminbar_thisblog_menu' to 'bp_adminbar_menus'.
+ * @uses add_action() To hook 'bp_adminbar_random_menu' to 'bp_adminbar_menus'.
+ * @uses add_action() To hook 'bp_core_admin_bar' to 'wp_footer'.
+ * @uses add_action() To hook 'bp_core_admin_bar' to 'admin_footer'.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_load_admin_bar() {
</span><span class="cx">
</span><span class="lines">@@ -88,9 +89,9 @@
</span><span class="cx"> add_action( 'init', 'bp_core_load_admin_bar', 9 );
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Handle the Toolbar CSS
</del><ins>+ * Handle the Toolbar CSS.
</ins><span class="cx"> *
</span><del>- * @since BuddyPress 1.5
</del><ins>+ * @since BuddyPress (1.5.0)
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_load_admin_bar_css() {
</span><span class="cx"> global $wp_styles;
</span></span></pre></div>
<a id="trunkbpcorebpcoreavatarsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-core/bp-core-avatars.php (7432 => 7433)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-core/bp-core-avatars.php 2013-10-16 00:52:42 UTC (rev 7432)
+++ trunk/bp-core/bp-core-avatars.php 2013-10-16 13:36:51 UTC (rev 7433)
</span><span class="lines">@@ -1,14 +1,14 @@
</span><span class="cx"> <?php
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * BuddyPress Avatars
</del><ins>+ * BuddyPress Avatars.
</ins><span class="cx"> */
</span><span class="cx">
</span><span class="cx"> // Exit if accessed directly
</span><span class="cx"> if ( !defined( 'ABSPATH' ) ) exit;
</span><span class="cx">
</span><span class="cx"> /***
</span><del>- * Set up the constants we need for avatar support
</del><ins>+ * Set up the constants we need for avatar support.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_set_avatar_constants() {
</span><span class="cx">
</span><span class="lines">@@ -50,6 +50,11 @@
</span><span class="cx"> }
</span><span class="cx"> add_action( 'bp_init', 'bp_core_set_avatar_constants', 3 );
</span><span class="cx">
</span><ins>+/**
+ * Set up global variables related to avatars.
+ *
+ * @since BuddyPress (1.5.0)
+ */
</ins><span class="cx"> function bp_core_set_avatar_globals() {
</span><span class="cx"> $bp = buddypress();
</span><span class="cx">
</span><span class="lines">@@ -477,15 +482,19 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Delete an existing avatar
</del><ins>+ * Delete an existing avatar.
</ins><span class="cx"> *
</span><del>- * Accepted values for $args are:
- * item_id - item id which relates to the object type.
- * object - the objetc type user, group, blog, etc.
- * avatar_dir - The directory where the avatars to be uploaded.
- *
- * @param mixed $args
- * @return bool Success/failure
</del><ins>+ * @param array $args {
+ * Array of function parameters.
+ * @type bool|int $item_id ID of the item whose avatar you're deleting.
+ * Defaults to the current item of type $object.
+ * @type string $object Object type of the item whose avatar you're
+ * deleting. 'user', 'group', 'blog', or custom. Default: 'user'.
+ * @type bool|string $avatar_dir Subdirectory where avatar is located.
+ * Default: false, which falls back on the default location
+ * corresponding to the $object.
+ * }
+ * @return bool True on success, false on failure.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_delete_existing_avatar( $args = '' ) {
</span><span class="cx">
</span><span class="lines">@@ -545,17 +554,20 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Handles avatar uploading.
</del><ins>+ * Handle avatar uploading.
</ins><span class="cx"> *
</span><del>- * The functions starts off by checking that the file has been uploaded properly using bp_core_check_avatar_upload().
- * It then checks that the file size is within limits, and that it has an accepted file extension (jpg, gif, png).
- * If everything checks out, crop the image and move it to its real location.
</del><ins>+ * The functions starts off by checking that the file has been uploaded
+ * properly using bp_core_check_avatar_upload(). It then checks that the file
+ * size is within limits, and that it has an accepted file extension (jpg, gif,
+ * png). If everything checks out, crop the image and move it to its real
+ * location.
</ins><span class="cx"> *
</span><del>- * @param array $file The appropriate entry the from $_FILES superglobal.
- * @param string $upload_dir_filter A filter to be applied to upload_dir
- * @return bool Success/failure
</del><span class="cx"> * @see bp_core_check_avatar_upload()
</span><span class="cx"> * @see bp_core_check_avatar_type()
</span><ins>+ *
+ * @param array $file The appropriate entry the from $_FILES superglobal.
+ * @param string $upload_dir_filter A filter to be applied to 'upload_dir'.
+ * @return bool True on success, false on failure.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_avatar_handle_upload( $file, $upload_dir_filter ) {
</span><span class="cx">
</span><span class="lines">@@ -671,7 +683,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Crop an uploaded avatar
</del><ins>+ * Crop an uploaded avatar.
</ins><span class="cx"> *
</span><span class="cx"> * $args has the following parameters:
</span><span class="cx"> * object - What component the avatar is for, e.g. "user"
</span><span class="lines">@@ -683,8 +695,23 @@
</span><span class="cx"> * crop_x - The horizontal starting point of the crop
</span><span class="cx"> * crop_y - The vertical starting point of the crop
</span><span class="cx"> *
</span><del>- * @param mixed $args
- * @return bool Success/failure
</del><ins>+ * @param array $args {
+ * Array of function parameters.
+ * @type string $object Object type of the item whose avatar you're
+ * handling. 'user', 'group', 'blog', or custom. Default: 'user'.
+ * @type string $avatar_dir Subdirectory where avatar should be stored.
+ * Default: 'avatars'.
+ * @type bool|int $item_id ID of the item that the avatar belongs to.
+ * @type bool|string $original_file Absolute papth to the original avatar
+ * file.
+ * @type int $crop_w Crop width. Default: the global 'full' avatar width,
+ * as retrieved by bp_core_avatar_full_width().
+ * @type int $crop_h Crop height. Default: the global 'full' avatar height,
+ * as retrieved by bp_core_avatar_full_height().
+ * @type int $crop_x The horizontal starting point of the crop. Default: 0.
+ * @type int $crop_y The vertical starting point of the crop. Default: 0.
+ * }
+ * @return bool True on success, false on failure.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_avatar_handle_crop( $args = '' ) {
</span><span class="cx">
</span><span class="lines">@@ -763,18 +790,16 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * bp_core_fetch_avatar_filter()
</del><ins>+ * Replace default WordPress avatars with BP avatars, if available.
</ins><span class="cx"> *
</span><del>- * Attempts to filter get_avatar function and let BuddyPress have a go
- * at finding an avatar that may have been uploaded locally.
</del><ins>+ * Filters 'get_avatar'.
</ins><span class="cx"> *
</span><del>- * @global array $authordata
- * @param string $avatar The result of get_avatar from before-filter
- * @param int|string|object $user A user ID, email address, or comment object
- * @param int $size Size of the avatar image (thumb/full)
- * @param string $default URL to a default image to use if no avatar is available
- * @param string $alt Alternate text to use in image tag. Defaults to blank
- * @return string
</del><ins>+ * @param string $avatar The avatar path passed to 'get_avatar'.
+ * @param int|string|object $user A user ID, email address, or comment object.
+ * @param int $size Size of the avatar image ('thumb' or 'full').
+ * @param string $default URL to a default image to use if no avatar is available.
+ * @param string $alt Alternate text to use in image tag. Default: ''.
+ * @return string BP avatar path, if found; else the original avatar path.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_fetch_avatar_filter( $avatar, $user, $size, $default, $alt = '' ) {
</span><span class="cx"> global $pagenow;
</span><span class="lines">@@ -815,10 +840,10 @@
</span><span class="cx"> add_filter( 'get_avatar', 'bp_core_fetch_avatar_filter', 10, 5 );
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Has the current avatar upload generated an error?
</del><ins>+ * Is the current avatar upload error-free?
</ins><span class="cx"> *
</span><del>- * @param array $file
- * @return bool
</del><ins>+ * @param array $file The $_FILES array.
+ * @return bool True if no errors are found. False if there are errors.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_check_avatar_upload( $file ) {
</span><span class="cx"> if ( isset( $file['error'] ) && $file['error'] )
</span><span class="lines">@@ -830,8 +855,8 @@
</span><span class="cx"> /**
</span><span class="cx"> * Is the file size of the current avatar upload permitted?
</span><span class="cx"> *
</span><del>- * @param array $file
- * @return bool
</del><ins>+ * @param array $file The $_FILES array.
+ * @return bool True if the avatar is under the size limit, otherwise false.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_check_avatar_size( $file ) {
</span><span class="cx"> if ( $file['file']['size'] > bp_core_avatar_original_max_filesize() )
</span><span class="lines">@@ -845,8 +870,8 @@
</span><span class="cx"> *
</span><span class="cx"> * Permitted file types are JPG, GIF and PNG.
</span><span class="cx"> *
</span><del>- * @param string $file
- * @return bool
</del><ins>+ * @param array $file The $_FILES array.
+ * @return bool True if the file extension is permitted, otherwise false.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_check_avatar_type($file) {
</span><span class="cx"> if ( ( !empty( $file['file']['type'] ) && !preg_match('/(jpe?g|gif|png)$/i', $file['file']['type'] ) ) || !preg_match( '/(jpe?g|gif|png)$/i', $file['file']['name'] ) )
</span><span class="lines">@@ -856,7 +881,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Fetches data from the BP root blog's upload directory.
</del><ins>+ * Fetch data from the BP root blog's upload directory.
</ins><span class="cx"> *
</span><span class="cx"> * Handy for multisite instances because all uploads are made on the BP root
</span><span class="cx"> * blog and we need to query the BP root blog for the upload directory data.
</span><span class="lines">@@ -864,13 +889,13 @@
</span><span class="cx"> * This function ensures that we only need to use {@link switch_to_blog()}
</span><span class="cx"> * once to get what we need.
</span><span class="cx"> *
</span><del>- * @since BuddyPress (1.8)
</del><ins>+ * @since BuddyPress (1.8.0)
</ins><span class="cx"> *
</span><span class="cx"> * @uses wp_upload_dir()
</span><span class="cx"> *
</span><del>- * @param string $type The variable we want to return from the $bp->avatars object.
- * Only 'upload_path' and 'url' are supported.
- * @return string
</del><ins>+ * @param string $type The variable we want to return from the $bp->avatars
+ * object. Only 'upload_path' and 'url' are supported. Default: 'upload_path'.
+ * @return string The avatar upload directory path.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_get_upload_dir( $type = 'upload_path' ) {
</span><span class="cx"> $bp = buddypress();
</span><span class="lines">@@ -948,35 +973,34 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * bp_core_avatar_upload_path()
</del><ins>+ * Get the absolute upload path for the WP installation.
</ins><span class="cx"> *
</span><del>- * Returns the absolute upload path for the WP installation
</del><ins>+ * @uses wp_upload_dir To get upload directory info
</ins><span class="cx"> *
</span><del>- * @uses wp_upload_dir To get upload directory info
- * @return string Absolute path to WP upload directory
</del><ins>+ * @return string Absolute path to WP upload directory.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_avatar_upload_path() {
</span><span class="cx"> return apply_filters( 'bp_core_avatar_upload_path', bp_core_get_upload_dir() );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * bp_core_avatar_url()
</del><ins>+ * Get the raw base URL for root site upload location.
</ins><span class="cx"> *
</span><del>- * Returns the raw base URL for root site upload location
</del><ins>+ * @uses wp_upload_dir To get upload directory info.
</ins><span class="cx"> *
</span><del>- * @uses wp_upload_dir To get upload directory info
- * @return string Full URL to current upload location
</del><ins>+ * @return string Full URL to current upload location.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_avatar_url() {
</span><span class="cx"> return apply_filters( 'bp_core_avatar_url', bp_core_get_upload_dir( 'url' ) );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Check if a given user ID has an uploaded avatar
</del><ins>+ * Check if a given user ID has an uploaded avatar.
</ins><span class="cx"> *
</span><del>- * @since BuddyPress (1.0)
- * @param int $user_id
- * @return boolean
</del><ins>+ * @since BuddyPress (1.0.0)
+ *
+ * @param int $user_id ID of the user whose avatar is being checked.
+ * @return bool True if the user has uploaded a local avatar. Otherwise false.
</ins><span class="cx"> */
</span><span class="cx"> function bp_get_user_has_avatar( $user_id = 0 ) {
</span><span class="cx">
</span><span class="lines">@@ -991,14 +1015,15 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Utility function for fetching an avatar dimension setting
</del><ins>+ * Utility function for fetching an avatar dimension setting.
</ins><span class="cx"> *
</span><del>- * @package BuddyPress
- * @since BuddyPress (1.5)
</del><ins>+ * @since BuddyPress (1.5.0)
</ins><span class="cx"> *
</span><del>- * @param string $type 'thumb' for thumbs, otherwise full
- * @param string $h_or_w 'height' for height, otherwise width
- * @return int $dim The dimension
</del><ins>+ * @param string $type Dimension type you're fetching dimensions for. 'thumb'
+ * or 'full'. Default: 'thumb'.
+ * @param string $h_or_w Which dimension is being fetched. 'height' or 'width'.
+ * Default: 'height'.
+ * @return int $dim The dimension.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_avatar_dimension( $type = 'thumb', $h_or_w = 'height' ) {
</span><span class="cx"> $bp = buddypress();
</span><span class="lines">@@ -1008,96 +1033,88 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Get the avatar thumb width setting
</del><ins>+ * Get the 'thumb' avatar width setting.
</ins><span class="cx"> *
</span><del>- * @package BuddyPress
- * @since BuddyPress (1.5)
</del><ins>+ * @since BuddyPress (1.5.0)
</ins><span class="cx"> *
</span><del>- * @return int The thumb width
</del><ins>+ * @return int The 'thumb' width.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_avatar_thumb_width() {
</span><span class="cx"> return apply_filters( 'bp_core_avatar_thumb_width', bp_core_avatar_dimension( 'thumb', 'width' ) );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Get the avatar thumb height setting
</del><ins>+ * Get the 'thumb' avatar height setting.
</ins><span class="cx"> *
</span><del>- * @package BuddyPress
- * @since BuddyPress (1.5)
</del><ins>+ * @since BuddyPress (1.5.0)
</ins><span class="cx"> *
</span><del>- * @return int The thumb height
</del><ins>+ * @return int The 'thumb' height.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_avatar_thumb_height() {
</span><span class="cx"> return apply_filters( 'bp_core_avatar_thumb_height', bp_core_avatar_dimension( 'thumb', 'height' ) );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Get the avatar full width setting
</del><ins>+ * Get the 'full' avatar width setting
</ins><span class="cx"> *
</span><del>- * @package BuddyPress
- * @since BuddyPress (1.5)
</del><ins>+ * @since BuddyPress (1.5.0)
</ins><span class="cx"> *
</span><del>- * @return int The full width
</del><ins>+ * @return int The 'full' width.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_avatar_full_width() {
</span><span class="cx"> return apply_filters( 'bp_core_avatar_full_width', bp_core_avatar_dimension( 'full', 'width' ) );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Get the avatar full height setting
</del><ins>+ * Get the 'full' avatar height setting.
</ins><span class="cx"> *
</span><del>- * @package BuddyPress
- * @since BuddyPress (1.5)
</del><ins>+ * @since BuddyPress (1.5.0)
</ins><span class="cx"> *
</span><del>- * @return int The full height
</del><ins>+ * @return int The 'full' height.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_avatar_full_height() {
</span><span class="cx"> return apply_filters( 'bp_core_avatar_full_height', bp_core_avatar_dimension( 'full', 'height' ) );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Get the max width for original avatar uploads
</del><ins>+ * Get the max width for original avatar uploads.
</ins><span class="cx"> *
</span><del>- * @package BuddyPress
- * @since BuddyPress (1.5)
</del><ins>+ * @since BuddyPress (1.5.0)
</ins><span class="cx"> *
</span><del>- * @return int The width
</del><ins>+ * @return int The max width for original avatar uploads.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_avatar_original_max_width() {
</span><span class="cx"> return apply_filters( 'bp_core_avatar_original_max_width', (int) buddypress()->avatar->original_max_width );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Get the max filesize for original avatar uploads
</del><ins>+ * Get the max filesize for original avatar uploads.
</ins><span class="cx"> *
</span><del>- * @package BuddyPress
- * @since BuddyPress (1.5)
</del><ins>+ * @since BuddyPress (1.5.0)
</ins><span class="cx"> *
</span><del>- * @return int The filesize
</del><ins>+ * @return int The max filesize for original avatar uploads.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_avatar_original_max_filesize() {
</span><span class="cx"> return apply_filters( 'bp_core_avatar_original_max_filesize', (int) buddypress()->avatar->original_max_filesize );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Get the default avatar
</del><ins>+ * Get the URL of the 'full' default avatar.
</ins><span class="cx"> *
</span><del>- * @package BuddyPress
- * @since BuddyPress (1.5)
</del><ins>+ * @since BuddyPress (1.5.0)
</ins><span class="cx"> *
</span><del>- * @return int The URL of the default avatar
</del><ins>+ * @return string The URL of the default avatar.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_avatar_default() {
</span><span class="cx"> return apply_filters( 'bp_core_avatar_default', buddypress()->avatar->full->default );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Get the default avatar thumb
</del><ins>+ * Get the URL of the 'thumb' default avatar.
</ins><span class="cx"> *
</span><del>- * @package BuddyPress
- * @since BuddyPress (1.5)
</del><ins>+ * @since BuddyPress (1.5.0)
</ins><span class="cx"> *
</span><del>- * @return int The URL of the default avatar thumb
</del><ins>+ * @return string The URL of the default avatar thumb.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_avatar_default_thumb() {
</span><span class="cx"> return apply_filters( 'bp_core_avatar_thumb', buddypress()->avatar->thumb->default );
</span></span></pre>
</div>
</div>
</body>
</html>