<!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][9596] trunk/src/bp-core/bp-core-theme-compatibility.php: Adds hooks documentation for bp-core-theme-compatibility.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/9596">9596</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/9596","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-03-05 05:01:29 +0000 (Thu, 05 Mar 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-theme-compatibility.php.
See <a href="http://buddypress.trac.wordpress.org/ticket/5940">#5940</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcorethemecompatibilityphp">trunk/src/bp-core/bp-core-theme-compatibility.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcorebpcorethemecompatibilityphp"></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/bp-core-theme-compatibility.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-theme-compatibility.php 2015-03-05 04:55:12 UTC (rev 9595)
+++ trunk/src/bp-core/bp-core-theme-compatibility.php 2015-03-05 05:01:29 UTC (rev 9596)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -164,6 +164,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string ID of the theme package in use.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_get_theme_compat_id() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the ID of the theme package being used.
+ *
+ * @since BuddyPress (1.7.0)
+ *
+ * @param string $id ID of the theme package in use.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_get_theme_compat_id', buddypress()->theme_compat->theme->id );
</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">@@ -180,6 +188,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string Name of the theme package currently in use.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_get_theme_compat_name() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the name of the theme package being used.
+ *
+ * @since BuddyPress (1.7.0)
+ *
+ * @param string $name Name of the theme package in use.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_get_theme_compat_name', buddypress()->theme_compat->theme->name );
</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">@@ -196,6 +212,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string The version string of the theme package currently in use.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_get_theme_compat_version() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the version of the theme package being used.
+ *
+ * @since BuddyPress (1.7.0)
+ *
+ * @param string $version The version string of the theme package in use.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_get_theme_compat_version', buddypress()->theme_compat->theme->version );
</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">@@ -212,6 +236,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string The absolute path of the theme package currently in use.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_get_theme_compat_dir() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the absolute path of the theme package being used.
+ *
+ * @since BuddyPress (1.7.0)
+ *
+ * @param string $dir The absolute path of the theme package in use.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_get_theme_compat_dir', buddypress()->theme_compat->theme->dir );
</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">@@ -229,6 +261,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string URL of the theme package currently in use.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_get_theme_compat_url() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the URL of the theme package being used.
+ *
+ * @since BuddyPress (1.7.0)
+ *
+ * @param string $url URL of the theme package in use.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_get_theme_compat_url', buddypress()->theme_compat->theme->url );
</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">@@ -249,6 +289,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> bp_detect_theme_compat_with_current_theme();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters whether or not to use theme compat for the active theme.
+ *
+ * @since BuddyPress (1.9.0)
+ *
+ * @param bool $use_with_current_theme True if the current theme needs theme compatibility.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_use_theme_compat_with_current_theme', buddypress()->theme_compat->use_with_current_theme );
</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">@@ -406,7 +453,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * For an example of how this function is used, see:
</span><span class="cx" style="display: block; padding: 0 10px"> * {@link BuddyPress::register_theme_packages()}.
</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"> * @see BP_Theme_Compat for a description of the $theme parameter arguments.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -597,9 +644,13 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Fires when resetting main query vars and filtering 'the_content' to output BuddyPress template parts.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * Use this action to execute code that will communicate to BuddyPress's
</span><span class="cx" style="display: block; padding: 0 10px"> * theme compatibility layer whether or not we're replacing the_content()
</span><span class="cx" style="display: block; padding: 0 10px"> * with some other template part.
</span><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"> do_action( 'bp_template_include_reset_dummy_post_data' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -636,6 +687,13 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the template name to include.
+ *
+ * @since BuddyPress (1.7.0)
+ *
+ * @param string $template Template name.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_template_include_theme_compat', $template );
</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">@@ -662,7 +720,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // the_content() that execute before theme compat has unhooked itself.
</span><span class="cx" style="display: block; padding: 0 10px"> bp_set_theme_compat_active( false );
</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 we have new content to replace the old content?
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the content to replace in the post.
+ *
+ * @since BuddyPress (1.7.0)
+ *
+ * @param string $content Original post content.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $new_content = apply_filters( 'bp_replace_the_content', $content );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Juggle the content around and try to prevent unsightly comments
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -823,7 +887,15 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $retval = is_buddypress() ? false : $open;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Allow override of the override
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters whether or not to force comments_status to closed for BuddyPress post types.
+ *
+ * @since BuddyPress (1.7.0)
+ *
+ * @param bool $retval Whether or not we are on a BuddyPress post type.
+ * @param bool $open True if comments open, false if closed.
+ * @param int $post_id Post ID for the checked post.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_force_comment_status', $retval, $open, $post_id );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>