<!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][12727] trunk/src/bp-core/bp-core-taxonomy.php: BP Types: improve the BP Core Taxonomy API</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 { white-space: pre-line; 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/12727">12727</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/12727","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>imath</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-09-21 00:42:58 +0000 (Mon, 21 Sep 2020)</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'>BP Types: improve the BP Core Taxonomy API
- Introduces the `bp_insert_term()` function to save a BP Type into the database.
- Introduces the `bp_get_terms()` function to retrieve BP Types from the database.
- Introduces the `bp_delete_term()` function to remove a BP Type from the database.
Props mercime, DJPaul, dcavins, boonebgorges, tw2113, sbrajesh
See <a href="http://buddypress.trac.wordpress.org/ticket/7179">#7179</a>
See <a href="http://buddypress.trac.wordpress.org/ticket/7181">#7181</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcoretaxonomyphp">trunk/src/bp-core/bp-core-taxonomy.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcorebpcoretaxonomyphp"></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-taxonomy.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-taxonomy.php 2020-09-19 18:19:45 UTC (rev 12726)
+++ trunk/src/bp-core/bp-core-taxonomy.php 2020-09-21 00:42:58 UTC (rev 12727)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -277,3 +277,201 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $term;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Add a new taxonomy term to the database.
+ *
+ * @since 7.0.0
+ *
+ * @param string $term The BP term name to add.
+ * @param string $taxonomy The BP taxonomy to which to add the BP term.
+ * @param array $args {
+ * Optional. Array of arguments for inserting a BP term.
+ * @type string $description The term description. Default empty string.
+ * @type string $slug The term slug to use. Default empty string.
+ * @type array $metas The term metas to add. Default empty array.
+ * }
+ * @return array|WP_Error An array containing the `term_id` and `term_taxonomy_id`,
+ * WP_Error otherwise.
+ */
+function bp_insert_term( $term, $taxonomy = '', $args = array() ) {
+ if ( ! taxonomy_exists( $taxonomy ) ) {
+ return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.', 'buddypress' ) );
+ }
+
+ $site_id = bp_get_taxonomy_term_site_id( $taxonomy );
+
+ $switched = false;
+ if ( $site_id !== get_current_blog_id() ) {
+ switch_to_blog( $site_id );
+ bp_register_taxonomies();
+ $switched = true;
+ }
+
+ $term_metas = array();
+ if ( isset( $args['metas'] ) ) {
+ $term_metas = (array) $args['metas'];
+ unset( $args['metas'] );
+ }
+
+ /**
+ * Fires before a BP Term is added to the database.
+ *
+ * @since 7.0.0
+ *
+ * @param string $term The BP term name to add.
+ * @param string $taxonomy The BP taxonomy to which to add the term.
+ * @param array $args Array of arguments for inserting a BP term.
+ */
+ do_action( 'bp_before_insert_term', $term, $taxonomy, $args );
+
+ $tt_id = wp_insert_term( $term, $taxonomy, $args );
+
+ if ( is_wp_error( $tt_id ) ) {
+ return $tt_id;
+ }
+
+ $term_id = reset( $tt_id );
+
+ if ( $term_metas ) {
+ bp_update_type_metadata( $term_id, $taxonomy, $term_metas );
+ }
+
+ if ( $switched ) {
+ restore_current_blog();
+ }
+
+ /**
+ * Fires when taxonomy terms have been set on BuddyPress objects.
+ *
+ * @since 7.0.0
+ *
+ * @param array $tt_ids An array containing the `term_id` and `term_taxonomy_id`.
+ * @param string $taxonomy Taxonomy name.
+ * @param array $term_metas The term metadata.
+ */
+ do_action( 'bp_insert_term', $tt_id, $taxonomy, $term_metas );
+
+ return $tt_id;
+}
+
+/**
+ * Get taxonomy BP Terms from the database.
+ *
+ * @since 7.0.0
+ *
+ * @param array $args {
+ * Array of arguments to query BP Terms.
+ * @see `get_terms()` for full description of arguments in case of a member type.
+ * }
+ * @return array The list of terms matching arguments.
+ */
+function bp_get_terms( $args = array() ) {
+ $args = bp_parse_args(
+ $args,
+ array(
+ 'taxonomy' => '',
+ 'number' => '',
+ 'hide_empty' => false,
+ ),
+ 'get_terms'
+ );
+
+ if ( ! $args['taxonomy'] ) {
+ return array();
+ }
+
+ $site_id = bp_get_taxonomy_term_site_id( $args['taxonomy'] );
+
+ $switched = false;
+ if ( $site_id !== get_current_blog_id() ) {
+ switch_to_blog( $site_id );
+ bp_register_taxonomies();
+ $switched = true;
+ }
+
+ $terms = get_terms( $args );
+
+ if ( $switched ) {
+ restore_current_blog();
+ }
+
+ /**
+ * Filter here to modify the BP Terms found into the database.
+ *
+ * @since 7.0.0
+ *
+ * @param array $terms The list of terms matching arguments.
+ * @param array $args Array of arguments used to query BP Terms.
+ */
+ return apply_filters(
+ 'bp_get_terms',
+ $terms,
+ $args
+ );
+}
+
+/**
+ * Deletes a BP Term.
+ *
+ * @since 7.0.0
+ *
+ * @param int $term_id The BP Term ID. Required.
+ * @param string $taxonomy The BP Taxonomy Name. Required.
+ * @return bool|WP_Error True on success, WP_Error on failure.
+ */
+function bp_delete_term( $term_id = 0, $taxonomy = '' ) {
+ if ( ! $term_id || ! $taxonomy ) {
+ return new WP_Error( 'missing_arguments', __( 'Sorry, the term ID and the taxonomy are required arguments.', 'buddypress' ) );
+ }
+
+ $site_id = bp_get_taxonomy_term_site_id( $taxonomy );
+
+ $switched = false;
+ if ( $site_id !== get_current_blog_id() ) {
+ switch_to_blog( $site_id );
+ bp_register_taxonomies();
+ $switched = true;
+ }
+
+ /**
+ * Fires before a BP Term is deleted from the database.
+ *
+ * @since 7.0.0
+ *
+ * @param int $term_id The BP Term ID.
+ * @param string $taxonomy The BP Taxonomy Name.
+ */
+ do_action( 'bp_before_delete_term', $term_id, $taxonomy );
+
+ $deleted = wp_delete_term( $term_id, $taxonomy );
+
+ if ( $switched ) {
+ restore_current_blog();
+ }
+
+ if ( is_wp_error( $deleted ) ) {
+ return $deleted;
+ }
+
+ if ( false === $deleted ) {
+ return new WP_Error( 'inexistant_term', __( 'Sorry, the term does not exist.', 'buddypress' ) );
+ }
+
+ if ( 0 === $deleted ) {
+ return new WP_Error( 'default_term', __( 'Sorry, the default term cannot be deleted.', 'buddypress' ) );
+ }
+
+ /**
+ * Fires once a BP Term has been deleted from the database.
+ *
+ * @since 7.0.0
+ *
+ * @param boolean $deleted True.
+ * @param int $term_id The deleted BP Term ID.
+ * @param string $taxonomy The BP Taxonomy Name of the deleted BP Term ID.
+ */
+ do_action( 'bp_delete_term', $deleted, $term_id, $taxonomy );
+
+ return $deleted;
+}
</ins></span></pre>
</div>
</div>
</body>
</html>