Merge pull request #350 from globeandmail/fix/338

fix/338: add Util function to fetch primary category

includes/functions/content-sync.php

@@ -276,7 +276,7 @@ function get_post_data( $post ) {
 		'plainText'           => wp_strip_all_tags( $content ),
 		'size'                => str_word_count( wp_strip_all_tags( $content ) ),
 		'allSections'         => Utils\get_post_categories_paths( $post->ID ),
-		'sectionNames'        => Utils\get_post_categories( $post->ID ),
+		'sectionNames'        => array( Utils\get_primary_category( $post->ID ) ),
 		'modifiedAt'          => gmdate( \DateTime::RFC3339, strtotime( $post->post_modified_gmt ) ),
 		'tags'                => Utils\get_post_tags( $post ),
 		'url'                 => $permalink,

includes/functions/utils.php

@@ -545,3 +545,28 @@ function get_post_categories( $post_id ) {
 function get_wp_sophi_versions() {
 	return 'wp-' . get_bloginfo( 'version' ) . ':plugin-' . SOPHI_WP_VERSION;
 }
+
+/**
+ * Get the primary term name.
+ *
+ * @param string $taxonomy Optional. The taxonomy to get the primary term ID for. Defaults to category.
+ * @param int    $post_id            Optional. Post to get the primary term ID for.
+ *
+ * @return string
+ */
+function get_primary_category( $post_id = 0, $taxonomy = 'category' ) {
+	if ( ! function_exists( 'yoast_get_primary_term_id' ) ) {
+		$post_terms = wp_get_post_terms( $post_id, $taxonomy );
+
+		if ( is_array( $post_terms ) && count( $post_terms ) > 0 ) {
+			return $post_terms[0]->name;
+		} else {
+			return '';
+		}
+	}
+
+	$primary_term_id  = yoast_get_primary_term_id( $taxonomy, $post_id );
+	$primary_category = get_term( $primary_term_id );
+
+	return $primary_category->name;
+}

phpunit.xml

@@ -2,7 +2,7 @@
 	bootstrap="tests/bootstrap.php"
 	backupGlobals="false"
 	processIsolation="false"
-	colors="false">
+	colors="true">
 	<testsuites>
 		<testsuite name="Default">
 			<directory suffix="Tests.php">./tests/phpunit</directory>

tests/phpunit/test-tools/Utils_Tests.php

@@ -45,4 +45,67 @@ public function data_provider_embedded_images() {
 			),
 		);
 	}
+
+	public function test_get_primary_category__default_category__yoast_deactivated() {
+		$term_array = array(
+			(object) array(
+				'term_id' => 10,
+				'name'    => 'Uncategorized',
+			)
+		);
+
+		\WP_Mock::userFunction( 'wp_get_post_terms', array(
+			'times'  => 1,
+			'args'   => array( null, 'category' ),
+			'return' => $term_array,
+		) );
+
+		$term_name = get_primary_category();
+
+		$this->assertEquals( $term_name, 'Uncategorized' );
+	}
+
+	public function test_get_primary_category__multiple_categories__yoast_deactivated() {
+		$term_array = array(
+			(object) array(
+				'term_id' => 10,
+				'name'    => 'Science',
+			),
+			(object) array(
+				'term_id' => 10,
+				'name'    => 'Uncategorized',
+			)
+		);
+
+		\WP_Mock::userFunction( 'wp_get_post_terms', array(
+			'times'  => 1,
+			'args'   => array( null, 'category' ),
+			'return' => $term_array,
+		) );
+
+		$term_name = get_primary_category();
+
+		$this->assertEquals( $term_name, 'Science' );
+	}
+
+	public function test_get_primary_category__default_category__yoast_activated() {
+		\WP_Mock::userFunction( 'yoast_get_primary_term_id', array(
+			'times'  => 1,
+			'args'   => array( 'category', null ),
+			'return' => 123,
+		) );
+
+		\WP_Mock::userFunction( 'get_term', array(
+			'times'  => 1,
+			'args'   => array( 123 ),
+			'return' => (object) array(
+				'term_id' => 123,
+				'name'    => 'Uncategorized',
+			),
+		) );
+
+		$term_name = get_primary_category();
+
+		$this->assertEquals( $term_name, 'Uncategorized' );
+	}
 }