<!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][5815] trunk/bp-core/bp-core-hooks.php: More verbose explanations in bp-core-hooks.php about how plugin dependency works.</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, #logmsg > ol { margin-left: 0; 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/5815">5815</a></dd>
<dt>Author</dt> <dd>johnjamesjacoby</dd>
<dt>Date</dt> <dd>2012-02-21 00:26:08 +0000 (Tue, 21 Feb 2012)</dd>
</dl>
<h3>Log Message</h3>
<pre>More verbose explanations in bp-core-hooks.php about how plugin dependency works.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpcorebpcorehooksphp">trunk/bp-core/bp-core-hooks.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpcorebpcorehooksphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-core/bp-core-hooks.php (5814 => 5815)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-core/bp-core-hooks.php 2012-02-21 00:19:12 UTC (rev 5814)
+++ trunk/bp-core/bp-core-hooks.php 2012-02-21 00:26:08 UTC (rev 5815)
</span><span class="lines">@@ -20,20 +20,29 @@
</span><span class="cx"> /**
</span><span class="cx"> * Attach BuddyPress to WordPress
</span><span class="cx"> *
</span><del>- * BuddyPress uses its own internal actions to help aid in additional plugin
</del><ins>+ * BuddyPress uses its own internal actions to help aid in third-party plugin
</ins><span class="cx"> * development, and to limit the amount of potential future code changes when
</span><del>- * updates to WordPress occur.
- */
-add_action( 'plugins_loaded', 'bp_loaded', 10 );
-add_action( 'init', 'bp_init', 10 );
-add_action( 'wp', 'bp_ready', 10 );
-add_action( 'admin_bar_menu', 'bp_setup_admin_bar', 20 ); // After WP core
-add_action( 'template_redirect', 'bp_template_redirect', 10 );
-add_action( 'wp_enqueue_scripts', 'bp_enqueue_scripts', 10 );
-add_action( 'template_redirect', 'bp_template_redirect', 10 );
-add_filter( 'template_include', 'bp_template_include', 10 );
-add_filter( 'after_theme_setup', 'bp_after_theme_setup', 10 );
-add_filter( 'map_meta_cap', 'bp_map_meta_caps', 10, 4 );
</del><ins>+ * updates to WordPress core occur.
+ *
+ * These actions exist to create the concept of 'plugin dependencies'. They
+ * provide a safe way for plugins to execute code *only* when BuddyPress is
+ * installed and activated, without needing to do complicated guesswork.
+ *
+ * For more information on how this works, see the 'Plugin Dependency' section
+ * near the bottom of this file.
+ *
+ * v--WordPress Actions v--BuddyPress Sub-actions
+ */
+add_action( 'plugins_loaded', 'bp_loaded', 10 );
+add_action( 'init', 'bp_init', 10 );
+add_action( 'wp', 'bp_ready', 10 );
+add_action( 'admin_bar_menu', 'bp_setup_admin_bar', 20 ); // After WP core
+add_action( 'template_redirect', 'bp_template_redirect', 10 );
+add_action( 'wp_enqueue_scripts', 'bp_enqueue_scripts', 10 );
+add_action( 'template_redirect', 'bp_template_redirect', 10 );
+add_filter( 'template_include', 'bp_template_include', 10 );
+add_filter( 'after_theme_setup', 'bp_after_theme_setup', 10 );
+add_filter( 'map_meta_cap', 'bp_map_meta_caps', 10, 4 );
</ins><span class="cx">
</span><span class="cx"> // Piggy back WordPress theme actions
</span><span class="cx"> add_action( 'wp_head', 'bp_head', 10 );
</span><span class="lines">@@ -79,6 +88,21 @@
</span><span class="cx"> add_action( 'bp_template_redirect', 'bp_actions', 2 );
</span><span class="cx"> add_action( 'bp_template_redirect', 'bp_screens', 4 );
</span><span class="cx">
</span><ins>+/**
+ * Plugin Dependency
+ *
+ * The purpose of the following actions is to mimic the behavior of something
+ * called 'plugin dependency' which enables a plugin to have plugins of their
+ * own in a safe and reliable way.
+ *
+ * We do this in BuddyPress by mirroring existing WordPress actions in many places
+ * allowing dependant plugins to hook into the BuddyPress specific ones, thus
+ * guaranteeing proper code execution only whenBuddyPresss is active.
+ *
+ * The following functions are wrappers for their actions, allowing them to be
+ * manually called and/or piggy-backed on top of other actions if needed.
+ */
+
</ins><span class="cx"> /** The hooks *****************************************************************/
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -181,7 +205,7 @@
</span><span class="cx"> /**
</span><span class="cx"> * Run the updater late on 'bp_admin_init' to ensure that all alterations
</span><span class="cx"> * to the permalink structure have taken place. This fixes the issue of
</span><del>- * permalinks not being flushed properly when a bbPress update occurs.
</del><ins>+ * permalinks not being flushed properly when a BuddyPress update occurs.
</ins><span class="cx"> */
</span><span class="cx"> //add_action( 'bp_admin_init', 'bp_setup_updater', 999 );
</span><span class="cx">
</span><span class="lines">@@ -215,7 +239,7 @@
</span><span class="cx"> /**
</span><span class="cx"> * Enqueue BuddyPress specific CSS and JS
</span><span class="cx"> *
</span><del>- * @since bbPress (r5812)
</del><ins>+ * @since BuddyPress (r5812)
</ins><span class="cx"> *
</span><span class="cx"> * @uses do_action() Calls 'bp_enqueue_scripts'
</span><span class="cx"> */
</span><span class="lines">@@ -227,7 +251,7 @@
</span><span class="cx"> * Piggy back action for BuddyPress sepecific theme actions once the theme has
</span><span class="cx"> * been setup and the theme's functions.php has loaded.
</span><span class="cx"> *
</span><del>- * @since bbPress (r5812)
</del><ins>+ * @since BuddyPress (r5812)
</ins><span class="cx"> *
</span><span class="cx"> * @uses do_action() Calls 'bp_after_theme_setup'
</span><span class="cx"> */
</span></span></pre>
</div>
</div>
</body>
</html>