How-To: Achievement Categories

(@djpaul)

This is cool. I see you went the custom taxonomy route, which is probably the best way to do this ??

I’ll have a proper read through in due course, and consider adding something like this if requests for categorised achievements are common.

Thread Starter

(@mikebronner)

Update: Improved achievement_with_category_edit_column function to be dynamic, in case the plugin gets updated with new columns. I choose the categories to be listed in the third column, but you can change that to whatever you like.

function achievement_with_category_edit_columns($columns)
	{
		$column_position = 3; //choose what position you want the categories to be added
		$columns_first = array_slice($columns, 0, $column_position - 1, true );
		$columns_last = array_slice($columns, $column_position - 1, null, true );
		$columns = array_merge(
			$columns_first,
			array('category' => _x('Category', 'Achievement category', 'dpa')),
			$columns_last,
		;)

		return $columns;
	}
	add_filter("manage_edit-achievement_columns", "achievement_with_category_edit_columns");

Thread Starter

(@mikebronner)

Update 2: Fixed register_achievements_post_type_override() function. Had a typo, which caused achievements to become undeletable. Please replace with the following in your functions.php in your child theme:

function register_achievements_post_type_override()
	{
		global $wp_post_types;

		$achievements = objectToArray(get_post_types(array('name'=>dpa_get_achievement_post_type()), 'objects'));
		$progresses = objectToArray(get_post_types(array('name'=>dpa_get_progress_post_type()), 'objects'));

		$achievements = $achievements[dpa_get_achievement_post_type()];
		$progresses = $progresses[dpa_get_progress_post_type()];

		$achievements["taxonomies"] = array('dpa_achievement_category');
		$progresses["taxonomies"] = array('dpa_achievement_category');

		unset($wp_post_types[dpa_get_achievement_post_type()]);
		unset($wp_post_types[dpa_get_progress_post_type()]);

		register_post_type( dpa_get_achievement_post_type(), $achievements );
		register_post_type( dpa_get_progress_post_type(), $progresses );
	}

Also, replace the achievement_with_category_edit_columns and achievement_with_category_custom_column functions with the following code. It has been updated to make the column name more unique, so as not to conflict with the normal categories in wordpress:

function achievement_with_category_edit_columns($columns)
	{
		$column_position = 3; //choose what position you want the categories to be added
		$columns_first = array_slice($columns, 0, $column_position - 1, true );
		$columns_last = array_slice($columns, $column_position - 1, null, true );
		$columns = array_merge(
			$columns_first,
			array('achievement_category' => _x('Category', 'Achievement category', 'dpa')),
			$columns_last
		);

		return $columns;
	}
	add_filter("manage_edit-achievement_columns", "achievement_with_category_edit_columns");

	function achievement_with_category_custom_columns( $column )
	{
		switch( $column )
		{
			case "achievement_category":
				echo get_the_term_list( $post->ID, 'dpa_achievement_category', '', ', ', '' );
				break;
		}
	}
	add_action("manage_posts_custom_column", "achievement_with_category_custom_columns");

Also add the following code to your functions.php in your child theme to make the achievement category column sortable:

function dpa_achievement_sortable_category_column( $columns )
	{
		$columns['achievement_category'] = 'dpa_achievement_category';

		return apply_filters('dpa_achievement_sortable_columns', $columns);
	}
	add_filter('manage_edit-achievement_sortable_columns', 'dpa_achievement_sortable_category_column');

	function dpa_achievement_category_column_sorting( $vars )
	{
		if( isset($vars['orderby']) && 'achievement_category' == $vars['orderby'] )
		{
			$vars = array_merge($vars, array('meta_key' => 'dpa_achievement_category', 'orderby'  => 'meta_value'));
		}
		return $vars;
	}
	add_filter('requests', 'dpa_achievement_category_column_sorting');

Thread Starter

(@mikebronner)

Update 3: (How I wish we could update our threads instead of having this mess of additional posts, but nevertheless, here goes.)
Updated register_achievements_post_type_override() function yet again, as the capabilities of the post type need to be reset (they are getting corrupted when they are queried, information is missing):

function register_achievements_post_type_override()
	{
		global $wp_post_types;

		$achievements = objectToArray(get_post_types(array('name'=>dpa_get_achievement_post_type()), 'objects'));
		$progresses = objectToArray(get_post_types(array('name'=>dpa_get_progress_post_type()), 'objects'));

		$achievements = $achievements[dpa_get_achievement_post_type()];
		$progresses = $progresses[dpa_get_progress_post_type()];

		$achievements["taxonomies"] = array('dpa_achievement_category');
		$progresses["taxonomies"] = array('dpa_achievement_category');
		$achievements["capabilities"] = dpa_get_achievement_caps();
		$progresses["capabilities"] = dpa_get_achievement_progress_caps();

		unset($wp_post_types[dpa_get_achievement_post_type()]);
		unset($wp_post_types[dpa_get_progress_post_type()]);

		register_post_type( dpa_get_achievement_post_type(), $achievements );
		register_post_type( dpa_get_progress_post_type(), $progresses );
	}

Thread Starter

(@mikebronner)

Update 4: Updated user profile admin page to group achievements by category for better overview and grouping. Add the following code to you functions.php in your child theme:

/* Group Achievements by Category in User Profile *****************************/
	function dpa_achievements_add_profile_fields_with_categories($user)
	{
		if (!is_super_admin()) {return;}
?>
		<h3><?php _e( 'Achievements Settings', 'dpa' ); ?></h3>
		<table class="form-table">
			<tr>
				<th><label for="dpa_achievements"><?php _ex( 'Total Points', "User&rsquo;s total points from unlocked Achievements", 'dpa' ); ?></label></th>
				<td><input type="number" name="dpa_achievements" id="dpa_achievements" value="<?php echo esc_attr( dpa_get_user_points( $user->ID ) ); ?>" class="regular-text" />
				</td>
			</tr>
<?php
		if ( dpa_has_achievements_custom( array( 'ach_populate_progress' => $user->ID, 'ach_progress_status' => dpa_get_unlocked_status_id(), 'posts_per_page' => -1, "orderby"=>"konb_term_relationships.term_taxonomy_id",) ) )
		{
?>
			<tr>
				<th scope="row"><?php _e( 'Unlocked Achievements', 'dpa' ); ?></th>
				<td>
					<fieldset>
						<legend class="screen-reader-text"><?php _e( 'Assign or remove achievements from this user', 'dpa' ); ?></legend>
<?php
			$previous_achievment_category = "";
			while ( dpa_achievements() )
			{
				dpa_the_achievement();
				$current_category = "";
				$categories = get_the_terms($post_id, 'dpa_achievement_category');
				foreach($categories as $category)
				{
					if (strlen($current_category) > 0)
					{
						$current_category .= ", ";
					}
					$current_category .= $category->name;
				}

				if ($current_category != $previous_achievment_category)
				{
					if ($previous_achievment_category != "")
					{
?>
						<br />
<?php
					}
					$previous_achievment_category = $current_category;
?>

						<strong><?php echo $current_category; ?>:</strong><br />
<?php
				}

?>
						<label><input type="checkbox" name="dpa_user_achievements[]" value="<?php echo esc_attr( dpa_get_the_achievement_ID() ); ?>" <?php checked( dpa_is_achievement_unlocked(), true ); ?>> <?php dpa_achievement_title(); ?></label><br />
<?php
			}
?>

					</fieldset>
				</td>
			</tr>
<?php
		}
?>
		</table>
<?php
		remove_action('edit_user_profile', array(achievements()->admin, 'add_profile_fields'));
	}
	add_action('edit_user_profile', 'dpa_achievements_add_profile_fields_with_categories', 9);

pmcvicker

(@pmcvicker)

A big +1 for this. Categories means I can display a sweet, filterable achievement catalog like this for my users via Themefluent’s Ajax Content Navigator, which will be handy with the 150+ achievements we’re going to have (just 3 sample ones loaded right now). Kudos to you!

Plugin Author

(@djpaul)

That’s the first useful argument for categories with Achievements. You are doing groundbreaking work with TSC, pmcvicker ??

Thread Starter

(@mikebronner)

Oh, so my reasons weren’t valid?! Hmmmpf ?? j/k

Nice achievements catalog, pmcvicker! I will be creating something similar eventually as well. Thanks for the example, it’s inspiring. ??

Plugin Author

(@djpaul)

A picture’s worth a thousand words ??

Thread Starter

(@mikebronner)

You’re right, I never did post my example here:
https://konb.info/forums/users/mike-bronner/

The first goal was to group the various achievements together to organize them.
The second goal will be in connection with dependent achievements to essentially build an achievements tree showing which ones you have earned, and what it takes to earn the others.

Additional categories will include Ranks and Offices.

Plugin Author

(@djpaul)

Ah hah. Neat.

Ok, let’s figure out how to add category support into a future release ??

Thread Starter

(@mikebronner)

Excellent, I’ll make a branch for it.

wickstim

(@wickstim)

11 years, 6 months ago

Mike, I have been lurking the site you have created and want to create something similar such as your badges, icons, achievement page and leaderboard. Did you do the graphics yourself? I think I can follow your instructions for the leaderboard, and I will need to get someone else to create my graphics. How did you put together this template/page https://challengebeta.mypcls.org/achievements/a-tale-for-every-tail/

Thread Starter

(@mikebronner)

11 years, 6 months ago

Hi wickstim,
Actually the site you are looking at belongs to pmcvicker. It appears that he modified the CSS for the achievement detail view.

Plugin Author