<!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][9545] trunk/src/bp-core/admin/bp-core-admin-functions.php: Adds hooks documentation for bp-core-admin-functions.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/9545">9545</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/9545","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:09:27 +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 for bp-core-admin-functions.php.
See <a href="http://buddypress.trac.wordpress.org/ticket/5940">#5940</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcoreadminbpcoreadminfunctionsphp">trunk/src/bp-core/admin/bp-core-admin-functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcoreadminbpcoreadminfunctionsphp"></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-functions.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-functions.php 2015-02-24 03:04:40 UTC (rev 9544)
+++ trunk/src/bp-core/admin/bp-core-admin-functions.php 2015-02-24 03:09:27 UTC (rev 9545)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -32,7 +32,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @global array $_parent_pages
</span><span class="cx" style="display: block; padding: 0 10px"> * @global array $_registered_pages
</span><span class="cx" style="display: block; padding: 0 10px"> * @global array $submenu
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.6)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.6.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_core_admin_backpat_menu() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $_parent_pages, $_registered_pages, $submenu;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -71,7 +71,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global string $plugin_page
</span><span class="cx" style="display: block; padding: 0 10px"> * @global array $submenu
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.6)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.6.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_core_modify_admin_menu_highlight() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $plugin_page, $submenu_file;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -93,7 +93,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * will never appear.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see bp_core_admin_backpat_menu()
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.6)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.6.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> * @todo Add convenience links into the markup once new positions are finalised.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_core_admin_backpat_page() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -119,7 +119,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * BuddyPress combines all its messages into a single notice, to avoid a preponderance of yellow
</span><span class="cx" style="display: block; padding: 0 10px"> * boxes.
</span><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.5)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.5.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @uses bp_current_user_can() to check current user permissions before showing the notices
</span><span class="cx" style="display: block; padding: 0 10px"> * @uses bp_is_root_blog()
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -164,7 +164,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * box. It is recommended that you hook this function to admin_init, so that your messages are
</span><span class="cx" style="display: block; padding: 0 10px"> * loaded in time.
</span><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.5)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.5.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $notice The notice you are adding to the queue.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $type The notice type; optional. Usually either "updated" or "error".
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -199,7 +199,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WPDB $wpdb WordPress DB object
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WP_Rewrite $wp_rewrite
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.2)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.2.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_core_activation_notice() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_rewrite, $wpdb;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -329,7 +329,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Redirect user to BuddyPress's What's New page on activation
</span><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"> * @internal Used internally to redirect BuddyPress to the about page on activation
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -370,13 +370,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Output the tabs in the admin area
</span><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.5)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.5.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $active_tab Name of the tab that is active. Optional.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_core_admin_tabs( $active_tab = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $tabs_html = '';
</span><span class="cx" style="display: block; padding: 0 10px"> $idle_class = 'nav-tab';
</span><span class="cx" style="display: block; padding: 0 10px"> $active_class = 'nav-tab nav-tab-active';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the admin tabs to be displayed.
+ *
+ * @since BuddyPress (1.9.0)
+ *
+ * @param array $value Array of tabs to output to the admin area.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $tabs = apply_filters( 'bp_core_admin_tabs', bp_core_get_admin_tabs( $active_tab ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Loop through tabs and build navigation
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -387,6 +395,12 @@
</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"> echo $tabs_html;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Fires after the output of tabs for the admin area.
+ *
+ * @since BuddyPress (1.5.0)
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_admin_tabs' );
</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">@@ -428,8 +442,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the tab data used in our wp-admin screens.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (2.2.0)
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $tabs Tab data.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (2.2.0)
</del><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_core_get_admin_tabs', $tabs );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -439,7 +454,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * adds contextual help to BuddyPress admin pages
</span><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"> * @todo Make this part of the BP_Component class and split into each component
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_core_add_contextual_help( $screen = '' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -529,7 +544,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * renders contextual help content to contextual help tabs
</span><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"> function bp_core_add_contextual_help_content( $tab = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -568,7 +583,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Add a separator to the WordPress admin menus
</span><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"> * @uses bp_current_user_can() To check users capability on root blog
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -603,7 +618,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Tell WordPress we have a custom menu order
</span><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 bool $menu_order Menu order
</span><span class="cx" style="display: block; padding: 0 10px"> * @uses bp_current_user_can() To check users capability on root blog
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -622,7 +637,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Move our custom separator above our custom post types
</span><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 array $menu_order Menu Order
</span><span class="cx" style="display: block; padding: 0 10px"> * @uses bp_current_user_can() To check users capability on root blog
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -641,7 +656,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Menu values
</span><span class="cx" style="display: block; padding: 0 10px"> $last_sep = is_network_admin() ? 'separator1' : 'separator2';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Filter the custom admin menus
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the custom admin menus.
+ *
+ * @since BuddyPress (1.7.0)
+ *
+ * @param array $value Empty array.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $custom_menus = (array) apply_filters( 'bp_admin_menu_order', array() );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Bail if no components have top level admin pages
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -687,7 +708,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * and the inputs have different keys in the $_REQUEST array. This function
</span><span class="cx" style="display: block; padding: 0 10px"> * reconciles the two values and returns a single action being performed.
</span><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"> * @return string
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_admin_list_table_current_bulk_action() {
</span></span></pre>
</div>
</div>
</body>
</html>