WordPress.org

Make WordPress Core

Opened 6 years ago

Last modified 3 months ago

#7030 new enhancement

get_category_parents needs improvement

Reported by: jayabb Owned by:
Milestone: Future Release Priority: normal
Severity: normal Version: 2.5.1
Component: Taxonomy Keywords: has-patch needs-testing gsoc
Focuses: template Cc:

Description

get_category_parents is fine for internal use and generating URLs etc. but it also has a template tag version which could use some enhancements.

Problems 1: It displays the separator at the end of the list as well as in between categories.

Problem 2: There is no way to override the title attribute when generating links.

Problem 3: This is more of a documentation and code readability issue than anything else, the "nicename" parameter is named back-to-front (i.e. FALSE means you get nice names and TRUE means you get slugs).

The following replacement function fixes all three issues (issue 3 fixed in the parameter name, still needs fixing in the docs):

function get_category_parents($id, $link = FALSE, $separator = '/', $useslug = FALSE, $trailingseparator = TRUE, $usedescfortitle = FALSE)
{
	$output = "";

	// Get the category from the id
	$category = &get_category($id);
	if(is_wp_error($category))
	{
		return $category;
	}

	// Use the slug or the category name
	if($useslug)
	{
		$name = $category->slug;
	}
	else
	{
		$name = $category->cat_name;
	}

	// If this is not a top-level parent, first get the parent of this category.
	if($category->parent && ($category->parent != $category->term_id))
	{
		$output = get_category_parents($category->parent, $link, $separator, $useslug, $trailingseparator, $usedescfortitle);

		// If the parent output did NOT contain a trailing separator
		// we need to add the separator between category names/links
		if(!$trailingseparator)
		{
			$output .= $separator;
		}
	}

	// Output a link or plain text
	if($link)
	{
		$title = "";

		// Use the category description or the default text for the link title
		if($usedescfortitle)
		{
			$title = $category->description;
		}

		if($title == "")
		{
			$title = "View all posts in " . $name;
		}

		// Add this category link onto the end of the string which already contains all of its parent links
		$output .= '<a href="' . get_category_link($category->term_id) . '" title="' . $title . '">' . $name . '</a>';
	}
	else
	{
		// Add this category name onto the end of the string which already contains all of its parent names
		$output .= $name;
	}

	// Add the trailing separator
	if($trailingseparator)
	{
		$output .= $separator;
	}

	return $output;
}

This updated function is backwards compatible with the old one, there should not be any behavioural differences. If someone could integrate and test it in the core for the next release it'd be much appreciated. Also change the docs so that nice name is called use slugs instead.

Ta,
-Jay

Attachments (2)

7030.diff (2.8 KB) - added by wojtek.szkutnik 4 years ago.
7030.get_ancestors.diff (2.2 KB) - added by scribu 4 years ago.
Use get_ancestors() in get_category_parents

Download all attachments as: .zip

Change History (9)

comment:1 ryan6 years ago

  • Milestone changed from 2.5.2 to 2.9

Milestone 2.5.2 deleted

comment:2 Denis-de-Bernardy5 years ago

  • Component changed from General to Template

comment:3 ryan4 years ago

  • Milestone changed from 2.9 to Future Release
  • Type changed from defect (bug) to enhancement

comment:4 wojtek.szkutnik4 years ago

  • Cc wojtek.szkutnik@… added
  • Keywords has-patch needs-testing gsoc added

wojtek.szkutnik4 years ago

scribu4 years ago

Use get_ancestors() in get_category_parents

comment:5 scribu4 years ago

In 7030.get_ancestors.diff the $visited argument is deprecated, since it's not needed anymore.

We should deprecate the entire function, since the parameters are a mess.

comment:7 nacin3 months ago

  • Component changed from Template to Taxonomy
  • Focuses template added
Note: See TracTickets for help on using tickets.