PHP Class WPDKCustomPostType

Since: 1.4.0
Author: =undo= ([email protected])
Inheritance: extends WPDKObject
Datei anzeigen Open project: wpxtreme/wpdk

Public Properties

Property Type Description
$__version string Override version
$id string Custom Post type ID
$url_images string Path images

Public Methods

Method Description
__construct ( string $id, array | string $args ) : WPDKCustomPostType Create an instance of WPDKCustomPostType class
_admin_body_class ( string $classes ) Filter the admin CSS classes.
_admin_head ( ) Fires in for a specific admin page based on $hook_suffix.
_admin_head_edit_php ( ) Fires in for a specific admin page based on $hook_suffix.
_admin_head_post_new_php ( ) Fires in for a specific admin page based on $hook_suffix.
_admin_head_post_php ( ) Fires in for a specific admin page based on $hook_suffix.
_admin_print_styles_edit_php ( ) Fires when styles are printed for a specific admin page based on $hook_suffix.
_admin_print_styles_post_new_php ( ) Fires when styles are printed for a specific admin page based on $hook_suffix.
_admin_print_styles_post_php ( ) Fires when styles are printed for a specific admin page based on $hook_suffix.
is ( ) : boolean Return TRUE if the current post type is this custom post type.
manage_edit_columns ( array $columns ) : array This filter allow to change the columns of list table for this custom post type.
manage_edit_sortable_columns ( array $columns ) : array List of sortable columns
manage_posts_custom_column ( array $column ) : array This filter allow to display the content of column
register_meta_box ( ) Ovveride this hook to register your custom meta box
save_post ( integer | string $post_id, object $post = '' ) : void This action is called when a post is save or updated. Use the save_post_{post_type} hook
shouldEnterTitleHere ( string $title ) : string Override this delegate method to change the pseudo-placeholder into the text input for title in edit/new post type form.
update ( integer | string $post_id, object $post ) Override this method to save/update your custom data.

Private Methods

Method Description
init_admin_hooks ( ) Init useful (common) admon hook

Method Details

__construct() public method

Optional $args contents: - label - Name of the post type shown in the menu. Usually plural. If not set, labels['name'] will be used. - labels - An array of labels for this post type. * If not set, post labels are inherited for non-hierarchical types and page labels for hierarchical ones. * You can see accepted values in {@link get_post_type_labels()}. - description - A short descriptive summary of what the post type is. Defaults to blank. - public - Whether a post type is intended for use publicly either via the admin interface or by front-end users. * Defaults to false. * While the default settings of exclude_from_search, publicly_queryable, show_ui, and show_in_nav_menus are inherited from public, each does not rely on this relationship and controls a very specific intention. - hierarchical - Whether the post type is hierarchical (e.g. page). Defaults to false. - exclude_from_search - Whether to exclude posts with this post type from front end search results. * If not set, the opposite of public's current value is used. - publicly_queryable - Whether queries can be performed on the front end for the post type as part of parse_request(). * ?post_type={post_type_key} * ?{post_type_key}={single_post_slug} * ?{post_type_query_var}={single_post_slug} * If not set, the default is inherited from public. - show_ui - Whether to generate a default UI for managing this post type in the admin. * If not set, the default is inherited from public. - show_in_menu - Where to show the post type in the admin menu. * If true, the post type is shown in its own top level menu. * If false, no menu is shown * If a string of an existing top level menu (eg. 'tools.php' or 'edit.php?post_type=page'), the post type will be placed as a sub menu of that. * show_ui must be true. * If not set, the default is inherited from show_ui - show_in_nav_menus - Makes this post type available for selection in navigation menus. * If not set, the default is inherited from public. - show_in_admin_bar - Makes this post type available via the admin bar. * If not set, the default is inherited from show_in_menu - menu_position - The position in the menu order the post type should appear. * show_in_menu must be true * Defaults to null, which places it at the bottom of its area. - menu_icon - The url to the icon to be used for this menu. Defaults to use the posts icon. * Pass a base64-encoded SVG using a data URI, which will be colored to match the color scheme. This should begin with 'data:image/svg+xml;base64,'. * Pass the name of a Dashicons helper class to use a font icon, e.g. 'dashicons-piechart'. * Pass 'none' to leave div.wp-menu-image empty so an icon can be added via CSS. - capability_type - The string to use to build the read, edit, and delete capabilities. Defaults to 'post'. * May be passed as an array to allow for alternative plurals when using this argument as a base to construct the capabilities, e.g. array('story', 'stories'). - capabilities - Array of capabilities for this post type. * By default the capability_type is used as a base to construct capabilities. * You can see accepted values in {@link get_post_type_capabilities()}. - map_meta_cap - Whether to use the internal default meta capability handling. Defaults to false. - supports - An alias for calling add_post_type_support() directly. Defaults to title and editor. * See {@link add_post_type_support()} for documentation. - register_meta_box_cb - Provide a callback function that sets up the meta boxes for the edit form. Do remove_meta_box() and add_meta_box() calls in the callback. - taxonomies - An array of taxonomy identifiers that will be registered for the post type. * Default is no taxonomies. * Taxonomies can be registered later with register_taxonomy() or register_taxonomy_for_object_type(). - has_archive - True to enable post type archives. Default is false. * Will generate the proper rewrite rules if rewrite is enabled. - rewrite - Triggers the handling of rewrites for this post type. Defaults to true, using $post_type as slug. * To prevent rewrite, set to false. * To specify rewrite rules, an array can be passed with any of these keys * 'slug' => string Customize the permastruct slug. Defaults to $post_type key * 'with_front' => bool Should the permastruct be prepended with WP_Rewrite::$front. Defaults to true. * 'feeds' => bool Should a feed permastruct be built for this post type. Inherits default from has_archive. * 'pages' => bool Should the permastruct provide for pagination. Defaults to true. * 'ep_mask' => const Assign an endpoint mask. * If not specified and permalink_epmask is set, inherits from permalink_epmask. * If not specified and permalink_epmask is not set, defaults to EP_PERMALINK - query_var - Sets the query_var key for this post type. Defaults to $post_type key * If false, a post type cannot be loaded at ?{query_var}={post_slug} * If specified as a string, the query ?{query_var_string}={post_slug} will be valid. - can_export - Allows this post type to be exported. Defaults to true. - delete_with_user - Whether to delete posts of this type when deleting a user. * If true, posts of this type belonging to the user will be moved to trash when then user is deleted. * If false, posts of this type belonging to the user will *not* be trashed or deleted. * If not set (the default), posts are trashed if post_type_supports('author'). Otherwise posts are not trashed or deleted. - _builtin - true if this post type is a native or "built-in" post_type. THIS IS FOR INTERNAL USE ONLY! - _edit_link - URL segement to use for edit link of this post type. THIS IS FOR INTERNAL USE ONLY! *
public __construct ( string $id, array | string $args ) : WPDKCustomPostType
$id string Post type key, must not exceed 20 characters.
$args array | string See optional args description above.
return WPDKCustomPostType

_admin_body_class() public method

This filter differs from the post_class or body_class filters in two important ways: 1. $classes is a space-separated string of class names instead of an array. 2. Not all core admin classes are filterable, notably: wp-admin, wp-core-ui, and no-js cannot be removed. Use to set the right icon for this custom post type.
public _admin_body_class ( string $classes )
$classes string Space-separated string of CSS classes.

_admin_head() public method

Fires in for a specific admin page based on $hook_suffix.
public _admin_head ( )

_admin_head_edit_php() public method

Fires in for a specific admin page based on $hook_suffix.
Since: 1.6.0

_admin_head_post_new_php() public method

Fires in for a specific admin page based on $hook_suffix.
Since: 1.6.0

_admin_head_post_php() public method

Fires in for a specific admin page based on $hook_suffix.
Since: 1.6.0

_admin_print_styles_edit_php() public method

Fires when styles are printed for a specific admin page based on $hook_suffix.
Since: 1.6.0

_admin_print_styles_post_new_php() public method

Fires when styles are printed for a specific admin page based on $hook_suffix.
Since: 1.6.0

_admin_print_styles_post_php() public method

Fires when styles are printed for a specific admin page based on $hook_suffix.
Since: 1.6.0

is() public method

Return TRUE if the current post type is this custom post type.
public is ( ) : boolean
return boolean

manage_edit_columns() public method

This filter allow to change the columns of list table for this custom post type.
public manage_edit_columns ( array $columns ) : array
$columns array The list table columns list array
return array

manage_edit_sortable_columns() public method

List of sortable columns
public manage_edit_sortable_columns ( array $columns ) : array
$columns array Array Default sortable columns
return array

manage_posts_custom_column() public method

This filter allow to display the content of column
public manage_posts_custom_column ( array $column ) : array
$column array The column
return array

register_meta_box() public method

Ovveride this hook to register your custom meta box
public register_meta_box ( )

save_post() public method

This action is called when a post is save or updated. Use the save_post_{post_type} hook
public save_post ( integer | string $post_id, object $post = '' ) : void
$post_id integer | string Post ID
$post object Optional. Post object
return void

shouldEnterTitleHere() public method

Override this delegate method to change the pseudo-placeholder into the text input for title in edit/new post type form.
Deprecation:
public shouldEnterTitleHere ( string $title ) : string
$title string Default placeholder
return string

update() public method

This method is called by hook action save_post_{post_type}`
public update ( integer | string $post_id, object $post )
$post_id integer | string Post ID
$post object Optional. Post object

Property Details

$__version public_oe property

Override version
public string $__version
return string

$id public_oe property

Custom Post type ID
public string $id
return string

$url_images public_oe property

Path images
Since: 1.4.8
public string $url_images
return string