Important! Making changes to WooCommerce template files. Custom Post Types Guide: Creation, Derivation, and Custom Fields Creating Custom Fields for Custom Post Types
We will also include a post editor feature Custom Fields (custom or custom fields) for each type and display the fields in new templates.
In WordPress, custom post types give you complete control over how to display content to your users. If you create posts on your blog, you can create custom styles just for those posts. If you write reviews about music or movies, you can add additional input areas in the posts you want, and they won't show up in other blog posts.
But before we continue, let's understand what user posts are.
What are WordPress Custom Post Types?
In a nutshell, WordPress custom post types allow you to sort posts based on their content. In WordPress, the default post types are Post, Page, Media, etc.
Typically, you write all your posts in the Posts section of the admin console, then assign a category to them. All entries of different types are in one list, which makes it difficult to distinguish them by content type.
Custom post types with their own links in the admin console take you to a list of posts of that type. Posts created this way can be assigned categories, like a regular post, so you have absolute freedom to sort and present posts in any way you want.
In the example above, if a user goes to the movie database section of your site, review posts will not be included. If you make 'Action' and 'Romance' categories, for example, your users will be able to go to the Action movie category and see all the reviews and movies in the category.
When you create a new post type, you have many settings, such as: where the link will be located in the admin menu, whether this type will be included in search results, whether it will support displaying a fragment of text, whether comments are allowed, and so on.
You can change various title texts (defined using an array $labels), such as rename Add New Post V Add New Movie. For example, you can rename the text Featured Image V Add Poster.
You can also enable the custom fields feature in your post editor, which is hidden by default and must be enabled via a link Screen Options at the top of the editor.
Continuing with the example of Movies and Movie Reviews, Movie publications can add custom/custom fields for parameters such as year of release, director, ratings and many others with a brief review of the movie as the content of the post.
Typically any field you create is available in any post type, so the plugin requires restrictions on each field where it can be accessed.
Creating New Post Types
When you create significant changes to WordPress, one of the available implementation options is to create a plugin. You can also create new custom post types in the file functions.php. For this guide we Let's create a plugin and continue using the example with the movie/reviews database.
To create a custom post type, you need to write several functions that call a WordPress function called register_post_type() with two parameters. Your function must be bound to an action hook init, otherwise the custom post type will not be registered correctly.
// The custom function MUST be hooked to the init action hook add_action("init", "lc_register_movie_post_type"); // A custom function that calls register_post_type function lc_register_movie_post_type() ( // Set various pieces of text, $labels is used inside the $args array $labels = array("name" => _x("Movies", "post type general name"), "singular_name" => _x("Movie", "post type singular name"), ...); // Set various pieces of information about the post type $args = array("labels" => $ labels, "description" => "My custom post type", "public" => true, ...); // Register the movie post type with all the information contained in the $arguments array register_post_type("movie", $ args); )
All custom functions must be prefixed to avoid conflicts with other plugins or theme functions. The prefix LC will be used here.
Two parameters for the function register_post_type() This:
- Record type name, maximum 20 characters, and must not contain spaces or capital letters
- An associative array called $args, which contains information about the record type in the form of key-value pairs 'key' => 'value'
Array $args
Most Commonly Used Keys for an Array $args shown below, all are optional:
- labels– array array, which specifies different pieces of text, for example ‘Add a new entry’ can be renamed to ‘Add a new movie’. The keys for the labels array are described below with explanations;
- description– a short and succinct description of the record type, it can be displayed in type templates, but is not used anywhere else;
- public– is the post type visible to the author and visitors, the default value is FALSE, which means it does not appear even in the Admin Console;
- exclude_from_search– whether records of this type will appear in regular search results, the default value is the opposite of public;
- publicly_queryable– can this type of post be retrieved using a URL, such as http://www.mywebsite.com/?post_type=movie, or in advanced use via the query_posts() function. The default value is public;
- show_ui– whether menu links and message editor are connected in the administrator control panel. The default value is public;
- show_in_nav_menus– whether entries of this type will be added to navigation menus created on the Appearance -> Menus page, the default value is public;
- show_in_menu– whether the post type link is displayed in the navigation of the admin console. FALSE – hides the link. TRUE – adds the link as a new top-level link. Entering a line allows you to place a link inside an existing top-level link, that is, enter parameters options-general.php places it under the Settings link.
- show_in_admin_bar– will this type of post appear above the Admin bar, under the link + New
- menu_position– the position of the new link in the navigation menu of the admin console, 5 is located below Posts, 100 is located below Settings, the entire list of positions can be found in the WordPress Codex
- hierarchical– whether a record can be assigned to a parent record, if the value is TRUE, then the array $supports must contain the 'page-attributes' parameter
- supports– selectively enables post functions such as: images, text fragments, custom fields, etc. If set to FALSE, then instead of an array, the editor for this type of post is turned off - useful if you want to close all posts of this type from editing, but leave them visible ( list of array values nee)
- taxonomies– an array of taxonomies that can be applied to publications of this type, taxonomies must already be registered - they are not created from here!
- has_archive– will posts of this type have archive pages, the URL has a permalink structure and the descriptive part of the URL is parameter 1 of the register_post_types() function, that is, http://www.mywebsite.com/movie_reviews/ will show all movie_review posts.
- query_var– TRUE or FALSE determines whether a post can be shown by querying the URL for the post type and post name, i.e. ‘http://www.mywebsite.com/? movie=the-matrix‘. If you enter a line of text, you need to place the text after the ? character, so 'film' will end up looking like '? film=the-matrix‘.
Arrays of labels
First key in the array $args called labels and must be an array. It specifies various pieces of text related to the post type. Since there may be a lot of data here, it's best to create an array called $labels for their storage. The code above makes it a little clearer what this means.
Below are some important keys for the labels array, all are optional:
- name– general names for the message type, for example, movies (movies)
- singular_name– a name for one entry of this type, for example, movie (movie)
- add_new– replacing the text ‘Add New’ with the specified text, for example, ‘Add Movie’
- add_new_item– replacement for ‘Add New Post’, for example, with ‘Add New Movie’
- edit_item– replacement for ‘Edit Post’, for example, with ‘Edit Movie’
- featured_image– replacement for ‘Featured Image’ in the post editor, for example, with ‘Movie Poster’
- set_featured_image– replacing ‘Set Featured Image’, for example, with this option ‘Add Movie Poster’
- menu_name– change the link text at the top level, the default link text is the key name
Array supports
// Enable specific features in the post editor for my post type $supports = array ("title", "editor", "author", "thumbnail"); // Disable ALL features of the post editor for my post type $supports = FALSE;One of the keys in the array $args called supports. This is a simple array where you record a list of post editor features that you want to enable for your post type. By default, only the title and editor are enabled.
You can also set FALSE instead of the array to disable all editor functions, turning off both the title and the content adding area. This means that the entry cannot be edited, but is still fully visible.
Here is a list of functions you can include in an array $supports:
- title (title)
- editor
- author – NOTE: this allows you to change the author of the post
- thumbnail (icon)
- excerpt (text fragment)
- trackbacks
- custom-fields (custom field)
- comments
- revisions (versions)
- page-attributes
- post-formats (post formats)
Creating a custom WordPress post type via a plugin
Now that we know what parameters the function needs, we can create our own plugin, write our own function and attach it to the event init.
lc_custom_post_movie() to the init action hook add_action("init", "lc_custom_post_movie"); // The custom function to register a movie post type function lc_custom_post_movie() ( // Set the labels, this variable is used in the $args array $labels = array("name" => __("Movies"), "singular_name " => __("Movie"), "add_new" => __("Add New Movie"), "add_new_item" => __("Add New Movie"), "edit_item" => __("Edit Movie") , "new_item" => __("New Movie"), "all_items" => __("All Movies"), "view_item" => __("View Movie"), "search_items" => __("Search Movies "), "featured_image" => "Poster", "set_featured_image" => "Add Poster"); // The arguments for our post type, to be entered as parameter 2 of register_post_type() $args = array("labels" => $labels, "description" => "Holds our movies and movie specific data", "public" => true, "menu_position" => 5, "supports" => array("title", "editor", " thumbnail", "excerpt", "comments", "custom-fields"), "has_archive" => true, "show_in_admin_bar" => true, "show_in_nav_menus" => true, "has_archive" => true, "query_var" = > "film"); // Call the actual WordPress function // Parameter 1 is a name for the post type // Parameter 2 is the $args array register_post_type("movie", $args); ) // Hook lc_custom_post_movie_reviews() to the init action hook add_action("init", "lc_custom_post_movie_reviews"); // The custom function to register a movie review post type function lc_custom_post_movie_reviews() ( // Set the labels, this variable is used in the $args array $labels = array("name" => __("Movie Reviews"), "singular_name" => __("Movie Review"), "add_new" => __("Add New Movie Review"), "add_new_item" => __("Add New Movie Review"), "edit_item" => __( "Edit Movie Review"), "new_item" => __("New Movie Review"), "all_items" => __("All Movie Reviews"), "view_item" => __("View Movie Reviews"), " search_items" => __("Search Movie Reviews")); // The arguments for our post type, to be entered as parameter 2 of register_post_type() $args = array("labels" => $labels, "description" = > "Holds our movie reviews", "public" => true, "menu_position" => 6, "supports" => array("title", "editor", "thumbnail", "excerpt", "comments", " custom-fields"), "has_archive" => true, "show_in_admin_bar" => true, "show_in_nav_menus" => true, "has_archive" => true); // Call the actual WordPress function // Parameter 1 is a name for the post type // $args array goes in parameter 2. register_post_type("review", $args); )
If you enable this plugin, you will see a new link in the navigation bar of the admin console, right after the Posts link.
When hovering the mouse, the menu items 'View All' and 'Add New' will be shown, the text will correspond to that which was specified in the array $labels. Look in the editor where the links have changed.
Limit custom fields for given records
When you add your fields to a record, the fields are saved and you can quickly add any to the new record. The custom fields you added will appear in the dropdown list of each entry. This can make it difficult to find the field you're looking for in certain post types. If you want to restrict custom fields so that they are only available for certain post types, then the easiest way is through a plugin.
get_post_meta()
- takes 3 parameters and returns result
- the first parameter is the post ID, you can use it here $post->ID to get the ID of the currently displayed entry
- second parameter – name of a custom record field, case sensitive
- the third parameter is of type boolean, called $single and can be TRUE (returns the result as a string) or FALSE (returns an array).
ID, "Box Art", TRUE); if (!empty($movie_box_art)) ( ?>NOTE: You can create multiple custom fields with the same name and different values. If there are multiple fields with the same name, setting FALSE will return an array of them.
" alt=" !}">
Since the function get_post_meta() returns a value, you can use the value in a conditional expression to change the appearance accordingly.
In the example above, we check to see if the movie contains box art assigned to it as a custom field. If $movie_box_art not empty, display div and image.
Displaying Advanced Custom Fields
// Display field value the_field("FIELD NAME"); // Return field value get_field("FIELD NAME");The Advanced Custom Fields plugin offers its own functions and shortcodes for displaying fields.
the_field(‘FIELD NAME’);
Displays the value of a specified field, you must use the Field Name you specified when creating the field group.
get_field('FIELD NAME');
Returns the value of the specified field, useful for conditional expressions.
These are the features you'll most likely need. There are many additional features and you can find them in .
Shortcodes
You can display fields directly on a post using the shortcode above.
Display a custom post type on the main page
// Hook our custom function to the pre_get_posts action hook add_action("pre_get_posts", "add_reviews_to_frontpage"); // Alter the main query function add_reviews_to_frontpage($query) ( if (is_home() && $query->is_main_query()) ( $query->set("post_type", array("post", "movie", "review ")); ) return $query; )Custom post types don't show up on the main page by default, so you need to create a new function that calls the object's set method WP_Query WordPress.
The function checks whether the visitor is on the home page and whether the active request is a primary one generated by WordPress.
$query->set() takes two parameters:
- the first parameter is the priority you want to change, in our case we change the priority post_type
- the second parameter is the array that you want to pass as the attribute value post_type
In the code example above, the array starts with 'post' - this is why every WordPress post is of type 'post' and we still want to include it on the main page.
If you only want to use custom posts of a given type on your home page, you can remove 'posts' and use your own post type.
The value you enter must match parameter 1 of the function register_post_type().
Conclusion
In this tutorial, we show how to create custom types and what data you need to have to do so. The flexibility of custom post types provides valuable functionality for any WordPress site.
Get a valuable feedback from your customers by giving them the freedom to share their impressions freely. Let them rate your products and/or services straight on your website. See below the key features that come standard with our online review system.
Reviews & Ratings
Embed PHP Review Script into your website and let clients share their experience with the products and services you offer. They can rate by criteria and give both positive and negative feedback.
Multiple Languages
The PHP review system can speak not only English, but any language you may need. You can translate all titles and system messages from the admin page using unique IDs for each piece of text.
Editable Rating Criteria
Depending on the type of business, review system admins can
set different rating criteria to be shown in the front-end form.
Each of these criteria is rated with 1 to 5 stars.
Email & SMS Notifications
Set up the online review system to send Email & SMS alerts when a new review has been posted. You can easily specify which users to receive these messages from the Users menu.
Multiple User Types
Create unlimited client types depending on the industry and services used. Hotel ratings can go with the following user types: Family with kids, Couple, Business trip etc. They appear as labels in the reviews.
Responsive & Attractive
The review and rating script runs on all devices, seamlessly adapting to various screen sizes. In accord with your website branding, you can pick the best matching front-end theme among 10 color options.
A quick tips box next to the review form allows you to add some witty words and draw customers out. The review system filters reviews by user type. Customers can rate other clients" ratings, too.
With a Developer License you get the source code and can make any custom changes to the PHP Review Script. We can also modify the customer review system upon request.
Answer
Based on https://toster.ru/q/276441 It’s clear that a lot depends on the project, so this post should be adapted to your case.
* Safety:
- Each argument of a simple type method must be checked for type in case of proxying and for boundary values in case of processing. If something goes wrong, an exception is thrown. If a method with several arguments consists of 80% verification of arguments, this is quite normal))
- No trigger_error, only exceptions.
- Exceptions MUST be human-understandable, all sorts of “Something went wrong” can be given to the user, but the log should contain an exception with a stack trace and a human-understandable description of what went wrong there.
- Each argument (object) of a method must be type-hinted to its class or interface.
- As a rule, eval is severely reprimanded
- @ is allowed only in desperate situations, for example the json_last_error check.
- Before working with the database, it is mandatory to check the data.
- No == and!=. With swtich - the only exception, depending on the situation.
- If the method returns not only bool, but something else, a strict check with ===, or!== is required.
- No conditions with assignments inside. while($row = ...) is also unacceptable.
- Magic getters/setters are allowed only in desperate situations, otherwise they are prohibited.
- Concatenations in sql - only in hopeless situations.
- Parameters in sql - ONLY through placeholders.
- No global variables.
- Dates in the form of a string are allowed only in templates and in the database; in PHP code they are immediately converted to \DateTimeImmutable (in desperate situations, \DateTime is allowed)
- Of course, it depends on the project, but as a rule there should be only two entry points: index.php for the web and console (or something else called) for the console.
* Codestyle PSR-2 + PSR-5 at least, + a bunch of more stringent requirements (for starters, everything that is marked as SHOULD in PSR becomes MUST)
- In PhpStorm, not a single line should be highlighted (the exception is typo errors, for example, the dictionary does not know some of the abbreviations adopted in your project). In this case, it is allowed to use /** @noinspection *** */ for hopeless situations.
- If someone says that they are writing in another editor and it is not highlighted, they still send it for revision.
* Code organization:
- No global functions.
- Classes without namespace are allowed only in extremely desperate situations.
* Testability (in the sense of ease of testing) of the code should be high.
- Code coverage is required for all possible cases of using each public method with dependency mocks.
* MVC principles:
- No processing of user input in models, literally at all.
- No queries to the database from templates.
- No layout/js/css/sql-in in controllers.
- There is NO MAGIC in the models, only private properties + getters with setters.
- Models are allowed to use the save method (if there is one, of course) only in exceptional situations. In all others - either insert or update.
* SOLID principles:
- No universal objects that can do everything.
- If the method for internal use is private, no public.
- Static methods are allowed only in cases of hopelessness.
* The DRY principle is allowed to be violated in the following cases:
- Explicit separation of duties
- In tests (each test should be as independent as possible)
* Working with the database:
- The request in the cycle must be REALLY justified.
- Severe reprimand for ORDER BY RAND()
- Search not by keys (of course, if the table is NOT 5 rows) is prohibited.
- Search without LIMIT (again, if the table is NOT 5 rows) is prohibited.
- SELECT * - prohibited.
- Denormalization of the database must be justified.
- MyISAM is not used (so)))
- Multiple operations are required in a transaction, with a rollback if something goes wrong.
- The database should not contain business logic, only data in a holistic form.
- There should be no unnecessary jerking of the database where it can be done without it.
* The cache must be cleared under two conditions (not one of them, but two):
- Time.
- Failure according to business logic.
It is only allowed for time in desperate situations, but then the time is a short period.
- When calculating cache keys, a variable from the application configuration should be used (in case of updates, the cache is reset by code, not by cache server flash). In the case of using many servers, this is a very convenient and flexible tool for diplomacy.
* About people:
- “I’m used to writing this way and will continue to do so” is not a question, you will only pass the review when you change your opinion.
- “I write in vim and it’s so convenient for me” - great, I also write console code in it)) but there are requirements for the code, if you can’t do them, you won’t pass the review.
- “I copied this terrible method and changed 2 lines” - this is of course wonderful, but according to the label, you are the author of this entire method, so let’s not talk nonsense, okay?
- “It works!” - this phrase translates roughly like this: “yes, I understand that I’m writing complete nonsense, but I can’t write normally because I can’t,” did I understand you correctly?))
- "Everything works!" - I'm happy for you, but what about the production?
- “Everything is simple there” - do not use the word “simple”, from the word “absolutely”. Here’s a piece of code (the first one you come across with complex business logic), where is the error (it doesn’t matter whether there is one or not)? You've been watching it for 2 minutes already, what's the problem, everything is "simple"))
* Anything:
ActiveRecord (I’m telling you this as a former Yii fan) is complete crap, take it as the original one. In fact, you have models connected to the database wandering around the project uncontrollably. More than once I came across that in the same templates they call save or update (you should be burned for this).
Basics:
1. The presence of critical errors and outdated functions.
2. Use of patterns, elegance of solutions.
3. Readability of the code, presence of comments, presence of docks.
4. Compliance with paradigms and conventions (for example, violation of MVC).
Secondary/not important:
1. Code performance (except for highload)
2. Memory consumption (excluding bigdata)
3. Efficiency of SQL queries (with the exception of very awkward ones)
4. Avoiding unimportant but potentially bottlenecks in the data (for example, slowing down the file system when there are a large number of images in the upload folder)
5. Novelty of the technologies used.
6. Justified\Unjustified\Excessive Cycling.
- The code does not contain obvious or potential errors.
- The code works as described in the documentation, technical specifications or accompanying comments.
- Coding style follows accepted coding rules
- The code has accompanying comments according to phpDoc
- The nesting of blocks does not exceed the 4th level.
- The code does not generate messages at the Strict, Warning, Notice, or Deprecated levels. If this cannot be avoided, then immediately before the line that generates this, you must force error_reporting to be disabled, and immediately after the line, error_reporting must be turned on to the original value (which was before). Such code must be documented in a special way.
- The commented out piece of code should be removed.
- HTML and JavaScript inserts are prohibited in PHP code (except for phpTemplate). All insertions must be made using special templates.
- Classes, functions, variables and constants must be named logically in a human-readable way in English according to coding standards. Naming in transliteration in Russian or other languages is not allowed
- The scope of variables and methods of classes must always be defined (private, protected, public).
- The size of one method should not exceed 40-50 lines.
- A variable used in a loop or in a conditional block must be initialized in advance.
- A variable must contain only one type at any time. An empty variable must contain null. ($var = false; $var = "test"; is not allowed. $var = null is allowed; $var = "test";).
- When passing class objects to methods, type checking must be used.
First, from a code organization standpoint, it’d be better to put all of the review logic into one or more includable files and then include it on product pages:
Include("includes/reviews.php");
This way, the product pages can remain unadulterated and the same review code can easily be used, or modified, as needed. The reviews.php script would do several things:
- Show the review form
- Handle the review form
- List the existing reviews
- Handle secondary actions, such as flagging reviews or comments as inappropriate, indicating that reviews were helpful, adding comments to reviews, indicating that comments where helpful, and so forth
Hopefully you’ve done plenty of web development already, so you know that a form for adding reviews would just be like so:
Clearly you’d want to use some CSS to make it pretty, but that’s the basic idea. The main catch is that the product ID and product type (or whatever the database must have in order to associate a review with an item) must be stored in hidden inputs. You’d have the PHP script that displays the product write these values to the inputs.
If login is required, you might add (PHP) code that only shows the form to logged-in users, or prints a comment saying the user must log in to review the product. Similarly, if you have a system in place for guaranteeing a person only ever reviews a product once, you’d have PHP check for that scenario before showing this form.
The form submission could go to a new page, but then the user would need to click the Back button to return to the product page, which isn’t ideal. I would instead submit the form back to the product page. For example, on any dynamic website, the same PHP script is used to display all the content of a specific type. In my Effortless E-Commerce with PHP and MySQL book, the first example site uses the page.php script to show any page of content. The action attribute of the form would point to the same page.php . You can accomplish this by just leaving the attribute empty, or by using PHP to dynamically set the value.
If the PHP page that lists the products requires that a value identifying the product be passed in the URL, then the form would need to store that value in a hidden input as well. (That may already be the case, with the product_id input, depending upon how the site is set up.) Secondarily, the product script would also need to be updated to allow for the product value to be received via POST .
For the reviews.php script to know when to handle a form submission, it can check how the script was accessed:
If ($_SERVER["REQUEST_METHOD"] == "POST") ( // Handle the form.
When the review form is submitted, the form data should be validated. You should also apply strip_tags() to the data to prevent Cross-Site Scripting (XSS) attacks or other bad behavior. And non-numeric values would be run through an escaping function, such as mysqli_real_escape_string() . Or you could just use prepared statements or stored procedures for better security and performance.
If you add an anchor to the form’s action attribute action="page.php#reviews"the user will be taken to the reviews section of the page upon the submission, which is a nice touch.
If the reviews.php script is also handling some of the other actionsinappropriate reviews or comments, helpful indicators, etc.the script would need to watch for those submissions, too. I would use hidden inputs named “task” to indicate which action is being taken.
In a separate article, I demonstrate how to use Ajax for a simple rating system. Similar Ajax code could be used for the review system, too.
