hm-utility-taxonomy

KO | EN

gitlite — search

#javascript #react #ai #golang #go #machine-learning #rust #linux #docker #macos #nodejs #openai #ios #open-source

hm-utility-taxonomy

(★ 10)

A hidden taxonomy, used for filtering of posts/pages etc. in a way that is more performant than using the likes of post meta

hm-utility-taxonomy 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Utility Taxonomy

A hidden taxonomy, used for filtering of posts/pages etc. in a way that is more performant than using the likes of post meta.

## Usage

A plugin or theme can add their options by adding the `hm-utility` taxonomy to desired post type(s) and registering the options:

```php
/**
 * Register custom post type
 */
function register_my_post_type() : void {
	register_post_type(
		'my-post-type',
		[
			// ... other arguments.
			'taxonomies' => [ 'hm-utility' /* more taxonomies */ ],
		]
	);
}
add_action( 'init, 'register_my_post_type' );
```

To add support for built-in post types or other post types that you don't have control over their registration, use `hm_utility_init` hook:

```php
/**
 * Add hm-utility taxonomy to `page` post type
 *
 * @param string $taxonomy HM Utility's taxonomy name.
 */
function my_add_utility_support( string $taxonomy ) : void {
	register_taxonomy_for_object_type( $taxonomy, 'page' );
}
add_action( 'hm_utility_init', 'my_add_utility_support' );
```

The options can then be registered via `hm_utility_options`:

```php
/**
 * Add utility options for page post type
 *
 * @param array  $options   All options.
 * @param string $post_type Post type name.
 *
 * @return array.
 */
function my_utility_options( $options, $post_type ) : array {
	if ( $post_type !== 'page' ) {
		return $options;
	}

$options[] = [
		'id'       => 'my-utility-options',
		'title'    => __( 'Something Extra', 'my-textdomain' ),
		'defaults' => [ // Optional. This will assign new posts to the terms set here.
			'option-one',
		],
		'options'  => [
			[
				'label' => __( 'Option One', 'my-textdomain' ),
				'value' => 'option-one', // Must be slug-formatted.
			],
			[
				'label' => __( 'Option Two', 'my-textdomain' ),
				'value' => 'option-two',
			],
		],
	];

return $options;
}
add_filter( 'hm_utility_options', 'my_utility_options', 10, 2 );
```

The block editor should now provide a Panel titled "Something Extra" on the Document sidebar that contains a list of checkboxes (or a toggle if there's only one option) based on the options registered above.

It is up to the plugin or theme to use the automatically created terms to [filter their queries](https://developer.wordpress.org/reference/classes/wp_query/#taxonomy-parameters). See also [Tom J Nowell's post](https://tomjn.com/2018/03/16/utility-taxonomies/) for example use cases. It's actually the inspiration behind this plugin ;-)

## CLI

This plugin provides a WP CLI command to assign default terms on existing posts:

```
wp hm-utility-taxonomy assign-defaults
```

Pass `--help` to the command to see available options.

## Release Process

After one or more PRs has merged to `main`, create a new release branch and follow these steps to tag a release.

Note that this process assumes you [have `nvm` installed](https://github.com/nvm-sh/nvm).

Before you start, update [package.json](./package.json), [plugin.php](./plugin.php) and [namespace.php](./inc/namespace.php) with your new target version number (`1.5.0` is used in the example below) and save those files.

```sh
# Create a release branch with your desired version number.
git checkout -b release-v1.5.0

# Make sure you're using the right version of Node.
# (If this step errors, install the missing version and try again.)
nvm use

# Clear out node_modules/ and install packages from lockfile.
rm -rf node_modules
npm install

# Stage and commit the updated package and plugin files, which should
# now all reflect the new version number you updated earlier.
# Note namespace.php contains version number in wp_enqueue_script.
git add plugin.php ./inc/namespace.php package.json package-lock.json
git commit -m 'Bump version -> 1.5.0'

# Run the build.
npm run build
```

At this point, you should test the compiled code. If everything works correctly,

```sh
# Commit the updated asset bundle.
git add assets
git commit -m 'Build JS assets for v1.5.0'
```

Next, push your branch to GitHub and create a release PR. Once that PR is approved and merged, tag your release:

```sh
git tag v1.5.0
git push origin --tags
```

You are done, and the updated plugin should be available inclusive of the built code at this new version number.

hm-utility-taxonomy

hm-utility-taxonomy 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

hm-utility-taxonomy

hm-utility-taxonomy 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README