November 28, 2023

Custom Post Type Widget Blocks Plugin

Custom Post Type Widgets for the Block Editor (Gutenberg). This WordPress plugin adds default Custom Post Type Widgets to the Block Editor.

Custom Post Type Widgets for the Block Editor (Gutenberg).
This WordPress plugin adds default Custom Post Type Widgets to the Block Editor.

You can filter by registered Custom Post Type or Taxonomy on the Block Editor.

Compatibility

WordPress version 5.8 or later
Gutenberg version 10.7 or later

Descriptions of Widget Blocks

Latest Posts (Custom Post Type)

display a list of your most recent custom posts.

Archives (Custom Post Type)

display a monthly archive of your custom posts.

Categories (Custom Post Type)

display a list of categories that has custom posts.

Calendar (Custom Post Type)

display a calendar of your site’s posts.

Latest Comments (Custom Post Type)

display a list of your most recent comments.

Search (Custom Post Type)

A search form for your site.

Hooks

Custom Post Type Widgets has its own hooks. See the reference for details.

Reference: https://github.com/thingsym/custom-post-type-widget-blocks#hooks

Support

If you have any trouble, you can use the forums or report bugs.

Contribution

Small patches and bug reports can be submitted a issue tracker in Github. Forking on Github is another good way. You can send a pull request.

Translating a plugin takes a lot of time, effort, and patience. I really appreciate the hard work from these contributors.

If you have created or updated your own language pack, you can send gettext PO and MO files to author. I can bundle it into plugin.

You can also contribute by answering issues on the forums.

Patches and Bug Fixes

Forking on Github is another good way. You can send a pull request.

Fork Custom Post Type Widget Blocks from GitHub repository
Create a feature branch: git checkout -b my-new-feature
Commit your changes: git commit -am ‘Add some feature’
Push to the branch: git push origin my-new-feature
Create new Pull Request

Contribute guidlines

If you would like to contribute, here are some notes and guidlines.

All development happens on the develop branch, so it is always the most up-to-date
The master branch only contains tagged releases
If you are going to be submitting a pull request, please submit your pull request to the develop branch
See about forking and pull requests

Test Matrix

For operation compatibility between PHP version and WordPress version, see below Github Actions.

Installation

Download and unzip files. Or install Custom Post Type Widget Blocks plugin using the WordPress plugin installer. In that case, skip 2.
Upload “custom-post-type-widget-blocks” to the “/wp-content/plugins/” directory.
Activate the plugin through the ‘Plugins’ menu in WordPress.
Add a widget block in block category ‘Custom Post Type Widget Blocks’ to the Block Editor.
Have fun!

IMPORTANT: By default, WordPress will not work Date-based permalinks of custom post type. Recommend that you install the plugin in order to edit the permalink, if you are using a Date-based permalinks.

And try the following: Custom Post Type Rewrite

Screenshots

Block category 'Custom Post Type Widget Blocks'

Changelog

1.6.2 – 2023.11.28

tested up to 6.4.1
fix npm scripts
fix npm dependencies
fix github workflows
add php 8.2 to ci
fix phpunit.xml config
phpunit-polyfills bump up
fix __experimentalGetSettings deprecated

1.6.1 – 2023.04.21

tested up to 6.2.0
fix jest config
update npm dependencies
change permission to 744 for cpy

1.6.0 – 2023.02.01

fix test case
apply textdomain to styles for block.json
update japanese translation
update pot
fix npm scripts
fix composer scripts
improve tag-cloud widget block
add showRedirectionPreventedNotice and using dangerouslySetInnerHTML
add return value if post is empty
update package.json
fix block.json
change from assertRegExp to assertMatchesRegularExpression
update github actions, Node.js 12 actions are deprecated

1.5.1 – 2022.10.19

fix workflows for php 8.0
fix composer.json
fix compatible with setUp(): void
update japanese translation
update pot
fix indent and line-break
fix npm scripts
fix load_textdomain and set_block_editor_translations methods for testability
add msgmerge to npm scripts
add support section and enhance contribution section
fix license

1.5.0 – 2022.08.24

update japanese translation
update pot
fix scss
add featured image option
fix search block layout
replace helper scss from base-styles
fix any postType eror
fix npm scripts

1.4.0 – 2022.06.10

tested up to 6.0.0
fix npm scripts
update npm dependencies
add test case
update japanese translation
update pot
add format argument
add ASC/DESC order option for archive
add get_year_link_custom_post_type and get_day_link_custom_post_type methods
add archive type option
apply textdomain to metadata
add constants CUSTOM_POST_TYPE_WIDGET_BLOCKS_DISABLE_LINKS_ARCHIVE and CUSTOM_POST_TYPE_WIDGET_BLOCKS_DISABLE_LINKS_CALENDAR
change arrays from brace to bracket
fix apply_filters argument
fix wp-plugin-unit-test.yml
rename variable name
add filters
fix the priority of the rewrite rule of register_post_type()
change assert from assertEquals to assertSame

1.3.1 – 2022.02.09

update npm dependencies
fix scss
exclude jest config in the archive

1.3.0 – 2022.02.04

tested up to 5.9.0
add Upgrade Notice
update japanese translation
update pot
remove global scope
fix fragment
add text domain for translation
add showOnlyTopLevel option to categories block
improve code structure
fix classnames
add jest unit test only php 7.4
fix to composer install via composer.json
apply a patch temporarily for CI
change to Requires at least 5.8.0
change os to ubuntu-20.04
bump up yoast/phpunit-polyfills version
add test case for jest
move jest.config.js to root path
fix npm scripts
update npm dependencies for jest
fix label
fix test case
change scss library from LibSass to dart sass
set the initial value an empty array
fix directory with phpunit.xml
change hook to block_categories_all
refine code, compliant with the latest source code for standard widget blocks
fix base styles
add timeout-minutes to workflows
add react-hooks plugin settings
change php distribute folder to blocks for block.json
fix Cannot read property ‘rest_base’ of undefined

1.2.2 – 2021.07.12

update dependencies with package.json
fix .editorconfig
ReferenceError: Cannot access ‘A’ before initialization
exclude README.md in package
fix latest comments layout
fix class name
add node-sass with package.json
add asset-release workflow

1.2.1 – 2021.03.16

fix npm scripts
remove CUSTOM_POST_TYPE_WIDGET_BLOCKS_PATH constant
update japanese translation
update pot
improve code with phpcs
add test case
add sponsor link
update wordpress-test-matrix
add FUNDING.yml
add donate link

1.2.0 – 2020.11.23

fix test case
move hooks
add load_dynamic_blocks method
add load_plugin_data method, change version number with wp_enqueue_*
add load_asset_file method
remove .travis.yml, change CI/CD to Github Actions
add workflow for unit test

1.1.1 – 2020.09.15

check class exists
imporve code with phpcs, phpmd and phpstan
reformat
add strict mode

1.1.0 – 2020.08.18

update japanese translation
update pot
imporve code with phpcs, phpmd and phpstan
update testunit configuration
add Disabled to latest posts block
add unstable__bootstrapServerSideBlockDefinitions
fix test case
change wp cache name
add hooks
change hook tags
add loading asset to register_block_type argument
change asset loading function from wp_enqueue_* to wp_register_*
add checking register_block_type function
change wp_enqueue_script dependency setting to use asset file
add CUSTOM_POST_TYPE_WIDGET_BLOCKS_PATH constant

1.0.1 – 2020.05.06 – for plugin review

remove prefix __ with define name
add LICENSE file

1.0.0 – 2020.05.04

Initial release