DEV Community

Christina Meador
Christina Meador

Posted on

A Beginner's Guide to Creating a Custom Post Type Plugin in WordPress

WordPress plugins are an essential part of extending the functionality of your website. One common customization is creating custom post types to better organize and display specific types of content. In this guide, we'll walk through the process of creating a stand-alone plugin for WordPress that adds a custom post type, allowing you to keep your custom functionality separate from your theme.

Step 1: Set Up Your Plugin Directory

Begin by creating a new directory for your plugin. Inside your WordPress installation's wp-content/plugins directory, create a new folder. Name it something descriptive, like custom-post-type-plugin.

Step 2: Create the Main Plugin File

Inside your newly created folder, create a PHP file for your plugin. You can name this file whatever you like, but it's a good practice to keep it related to the plugin's functionality. For example, custom-post-type.php.

Step 3: Define Your Plugin Header

In the PHP file you just created, start by adding a plugin header. This header contains important information about your plugin, such as its name, description, version, and author. Here's an example header:

<?php
/*
Plugin Name: Custom Post Type Plugin
Description: This plugin adds a custom post type to WordPress.
Version: 1.0
Author: Your Name
*/
Enter fullscreen mode Exit fullscreen mode

Step 4: Register the Custom Post Type

Now it's time to define and register your custom post type. Add the following code to your plugin file:

<?php
/*
Plugin Name: Custom Post Type Plugin
Description: This plugin adds a custom post type to WordPress.
Version: 1.0
Author: Your Name
*/
Step 4: Register the Custom Post Type
Next, you need to define and register your custom post type. Add the following code to your custom-post-type.php file:

php
Copy code
// Register Custom Post Type
function custom_post_type() {

    $labels = array(
        'name'                  => _x( 'Custom Posts', 'Post Type General Name', 'text_domain' ),
        'singular_name'         => _x( 'Custom Post', 'Post Type Singular Name', 'text_domain' ),
        'menu_name'             => __( 'Custom Posts', 'text_domain' ),
        'all_items'             => __( 'All Custom Posts', 'text_domain' ),
        'add_new'               => __( 'Add New', 'text_domain' ),
        'add_new_item'          => __( 'Add New Custom Post', 'text_domain' ),
        'edit_item'             => __( 'Edit Custom Post', 'text_domain' ),
        'new_item'              => __( 'New Custom Post', 'text_domain' ),
        'view_item'             => __( 'View Custom Post', 'text_domain' ),
        'search_items'          => __( 'Search Custom Posts', 'text_domain' ),
        'not_found'             => __( 'No custom posts found', 'text_domain' ),
        'not_found_in_trash'    => __( 'No custom posts found in trash', 'text_domain' ),
        'parent_item_colon'     => __( 'Parent Custom Post:', 'text_domain' ),
        'featured_image'        => __( 'Featured image for this custom post', 'text_domain' ),
        'set_featured_image'    => __( 'Set featured image for this custom post', 'text_domain' ),
        'remove_featured_image' => __( 'Remove featured image for this custom post', 'text_domain' ),
        'use_featured_image'    => __( 'Use as featured image for this custom post', 'text_domain' ),
        'archives'              => __( 'Custom Post archives', 'text_domain' ),
        'insert_into_item'      => __( 'Insert into custom post', 'text_domain' ),
        'uploaded_to_this_item' => __( 'Uploaded to this custom post', 'text_domain' ),
        'filter_items_list'     => __( 'Filter custom posts list', 'text_domain' ),
        'items_list_navigation' => __( 'Custom posts list navigation', 'text_domain' ),
        'items_list'            => __( 'Custom posts list', 'text_domain' ),
    );
    $args = array(
        'label'                 => __( 'Custom Post', 'text_domain' ),
        'description'           => __( 'Custom post type description', 'text_domain' ),
        'labels'                => $labels,
        'supports'              => array( 'title', 'editor', 'thumbnail', 'custom-fields' ),
        'taxonomies'            => array( 'category', 'post_tag' ),
        'hierarchical'          => false,
        'public'                => true,
        'show_ui'               => true,
        'show_in_menu'          => true,
        'menu_position'         => 5,
        'show_in_admin_bar'     => true,
        'show_in_nav_menus'     => true,
        'can_export'            => true,
        'has_archive'           => true,
        'exclude_from_search'   => false,
        'publicly_queryable'    => true,
        'capability_type'       => 'post',
        'show_in_rest'          => true,
    );
    register_post_type( 'custom_post', $args );

}
add_action( 'init', 'custom_post_type', 0 );
Enter fullscreen mode Exit fullscreen mode

This code registers a custom post type named 'Custom Post' with basic options. You can customize the labels, arguments, and other settings according to your requirements.

Step 5: Test Your Plugin

Save your plugin file and navigate to the WordPress admin dashboard. Go to the 'Plugins' page, where you should see your newly created plugin listed. Activate it, and your custom post type should now be available in the WordPress admin menu.

By following these steps, you've created a stand-alone plugin for WordPress that adds a custom post type. This approach keeps your custom functionality separate from your theme, making it easier to maintain and update your site in the future. Experiment with different options and functionalities to tailor the plugin to your specific needs. Happy plugin development!

Top comments (0)