<!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][9543] trunk/src/bp-core/admin/bp-core-admin-actions.php: Adds hooks documentation and cleanup to bp-core-admin-actions.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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/9543">9543</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/9543","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>tw2113</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-02-24 03:00:07 +0000 (Tue, 24 Feb 2015)</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'>Adds hooks documentation and cleanup to bp-core-admin-actions.php.
See <a href="http://buddypress.trac.wordpress.org/ticket/5940">#5940</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcoreadminbpcoreadminactionsphp">trunk/src/bp-core/admin/bp-core-admin-actions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcoreadminbpcoreadminactionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/admin/bp-core-admin-actions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/admin/bp-core-admin-actions.php 2015-02-23 19:50:04 UTC (rev 9542)
+++ trunk/src/bp-core/admin/bp-core-admin-actions.php 2015-02-24 03:00:07 UTC (rev 9543)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,13 +1,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * BuddyPress Admin Actions
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * BuddyPress Admin Actions.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * This file contains the actions that are used through-out BuddyPress Admin. They
</span><span class="cx" style="display: block; padding: 0 10px"> * are consolidated here to make searching for them easier, and to help developers
</span><span class="cx" style="display: block; padding: 0 10px"> * understand at a glance the order in which things occur.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * There are a few common places that additional actions can currently be found
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * There are a few common places that additional actions can currently be found.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * - BuddyPress: In {@link BuddyPress::setup_actions()} in BuddyPress.php
</span><span class="cx" style="display: block; padding: 0 10px"> * - Admin: More in {@link bp_Admin::setup_actions()} in admin.php
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -22,7 +22,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> defined( 'ABSPATH' ) || exit;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Attach BuddyPress to WordPress
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Attach BuddyPress to WordPress.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * BuddyPress uses its own internal actions to help aid in third-party plugin
</span><span class="cx" style="display: block; padding: 0 10px"> * development, and to limit the amount of potential future code changes when
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -60,16 +60,16 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * When a new site is created in a multisite installation, run the activation
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * routine on that site
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * routine on that site.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.7)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.7.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $blog_id
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $user_id
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $domain
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $path
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $site_id
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array() $meta
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $meta
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_new_site( $blog_id, $user_id, $domain, $path, $site_id, $meta ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -80,7 +80,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Switch to the new blog
</span><span class="cx" style="display: block; padding: 0 10px"> switch_to_blog( $blog_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Do the BuddyPress activation routine
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires the activation routine for a new site created in a multisite installation.
+ *
+ * @since BuddyPress (1.7.0)
+ *
+ * @param int $blog_id ID of the blog being installed to.
+ * @param int $user_id ID of the user the install is for.
+ * @param string $domain Domain to use with the install.
+ * @param string $path Path to use with the install.
+ * @param int $site_id ID of the site being installed to.
+ * @param array $meta Metadata to use with the site creation.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_new_site', $blog_id, $user_id, $domain, $path, $site_id, $meta );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // restore original blog
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -90,42 +101,66 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /** Sub-Actions ***************************************************************/
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Piggy back admin_init action
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Piggy back admin_init action.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.7)
- * @uses do_action() Calls 'bp_admin_init'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.7.0)
+ * @uses do_action() Calls 'bp_admin_init'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_admin_init() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Fires inside the bp_admin_init function.
+ *
+ * @since BuddyPress (1.6.0)
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_admin_init' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Piggy back admin_menu action
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Piggy back admin_menu action.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.7)
- * @uses do_action() Calls 'bp_admin_menu'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.7.0)
+ * @uses do_action() Calls 'bp_admin_menu'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_admin_menu() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Fires inside the bp_admin_menu function.
+ *
+ * @since BuddyPress (1.7.0)
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_admin_menu' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Piggy back admin_head action
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Piggy back admin_head action.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.7)
- * @uses do_action() Calls 'bp_admin_head'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.7.0)
+ * @uses do_action() Calls 'bp_admin_head'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_admin_head() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Fires inside the bp_admin_head function.
+ *
+ * @since BuddyPress (1.6.0)
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_admin_head' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Piggy back admin_notices action
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Piggy back admin_notices action.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.7)
- * @uses do_action() Calls 'bp_admin_notices'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.7.0)
+ * @uses do_action() Calls 'bp_admin_notices'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_admin_notices() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Fires inside the bp_admin_notices function.
+ *
+ * @since BuddyPress (1.5.0)
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_admin_notices' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -137,38 +172,66 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @uses do_action() Calls 'bp_admin_enqueue_scripts''.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $hook_suffix The current admin page, passed to
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * 'admin_enqueue_scripts'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 'admin_enqueue_scripts'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_admin_enqueue_scripts( $hook_suffix = '' ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Fires inside the bp_admin_enqueue_scripts function.
+ *
+ * @since BuddyPress (1.7.0)
+ *
+ * @param string $hook_suffix The current admin page, passed to admin_enqueue_scripts.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_admin_enqueue_scripts', $hook_suffix );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Dedicated action to register BuddyPress importers
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Dedicated action to register BuddyPress importers.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.7)
- * @uses do_action() Calls 'bp_admin_notices'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.7.0)
+ * @uses do_action() Calls 'bp_admin_notices'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_register_importers() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Fires inside the bp_register_importers function.
+ *
+ * Used to register a BuddyPress importer.
+ *
+ * @since BuddyPress (1.7.0)
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_register_importers' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Dedicated action to register admin styles
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Dedicated action to register admin styles.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.7)
- * @uses do_action() Calls 'bp_admin_notices'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.7.0)
+ * @uses do_action() Calls 'bp_admin_notices'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_register_admin_style() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Fires inside the bp_register_admin_style function.
+ *
+ * @since BuddyPress (1.7.0)
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_register_admin_style' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Dedicated action to register admin settings
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Dedicated action to register admin settings.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.7)
- * @uses do_action() Calls 'bp_register_admin_settings'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.7.0)
+ * @uses do_action() Calls 'bp_register_admin_settings'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_register_admin_settings() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Fires inside the bp_register_admin_settings function.
+ *
+ * @since BuddyPress (1.6.0)
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_register_admin_settings' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>