sergiotarxz/Wordpress
sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

category_description() should be taxonomy-agnostic.

Browse Source 
This change reinstates the previous de facto behavior of `category_description()`.
See [40979], [42364]. Because `term_description()` no longer passes `$taxonomy` to
`get_term_field()`, the parameter is no longer needed and has been deprecated.

Fixes #42605. See #42771.

git-svn-id: https://develop.svn.wordpress.org/trunk@42368 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Boone Gorges 2017-12-04 21:48:24 +00:00
parent ffb86c0552
commit 2e5bbe0667
2 changed files with 82 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/wp-includes/category-template.php
View File

@ -1200,20 +1200,19 @@ function tag_description( $tag = 0 ) {
* Retrieve term description. * Retrieve term description.
* *
* @since 2.8.0 * @since 2.8.0
* @since 4.9.2 The `$taxonomy` parameter was deprecated.
* *
* @param int $term Optional. Term ID. Will use global term ID by default. * @param int $term Optional. Term ID. Will use global term ID by default.
* @param string $taxonomy Optional taxonomy name. Defaults to 'post_tag'.
* @return string Term description, available. * @return string Term description, available.
*/ */
function term_description( $term = 0, $taxonomy = 'post_tag' ) { function term_description( $term = 0 ) {
if ( ! $term && ( is_tax() || is_tag() || is_category() ) ) { if ( ! $term && ( is_tax() || is_tag() || is_category() ) ) {
$term = get_queried_object(); $term = get_queried_object();
if ( $term ) { if ( $term ) {
$taxonomy = $term->taxonomy; $term = $term->term_id;
$term = $term->term_id;
} }
} }
$description = get_term_field( 'description', $term, $taxonomy ); $description = get_term_field( 'description', $term );
return is_wp_error( $description ) ? '' : $description; return is_wp_error( $description ) ? '' : $description;
} }

78
tests/phpunit/tests/category/categoryDescription.php Normal file
View File

@ -0,0 +1,78 @@
<?php
/**
* @group taxonomy
* @covers ::category_description
*/
class Tests_Category_CategoryDescription extends WP_UnitTestCase {
public function test_success_query_by_id() {
$description = 'Foo';
$c = self::factory()->category->create( array(
'description' => $description,
) );
$found = category_description( $c );
$expected = apply_filters( 'term_description', $description );
$this->assertSame( $expected, $found );
}
public function test_success_query_by_object() {
$description = 'Foo';
$c = self::factory()->category->create( array(
'description' => $description,
'slug' => 'bar',
) );
$category = get_term( $c );
$found = category_description( $c );
$expected = apply_filters( 'term_description', $description );
$this->assertSame( $expected, $found );
}
/**
* @ticket 42605
* @ticket 42771
*/
public function test_should_return_description_for_term_from_another_taxonomy_on_primed_cache() {
register_taxonomy( 'wptests_tax', 'post' );
$description = 'Foo';
$t = self::factory()->term->create( array(
'taxonomy' => 'wptests_tax',
'description' => $description,
) );
$term = get_term( $t );
$found = category_description( $t );
$expected = apply_filters( 'term_description', $description );
$this->assertSame( $expected, $found );
}
/**
* @ticket 42605
* @ticket 42771
*/
public function test_should_return_description_for_term_from_another_taxonomy_on_empty_cache() {
register_taxonomy( 'wptests_tax', 'post' );
$description = 'Foo';
$t = self::factory()->term->create( array(
'taxonomy' => 'wptests_tax',
'description' => $description,
) );
clean_term_cache( $t );
$found = category_description( $t );
$expected = apply_filters( 'term_description', $description );
$this->assertSame( $expected, $found );
}
}