Add Usage to comment

10up · Apr 2, 2024 · f9ae10a · f9ae10a
1 parent 8e9c890
commit f9ae10a
Showing 1 changed file with 25 additions and 0 deletions.
diff --git a/mu-plugins/10up-plugin/includes/classes/PostTypes/AbstractPostType.php b/mu-plugins/10up-plugin/includes/classes/PostTypes/AbstractPostType.php
@@ -11,6 +11,31 @@
 
 /**
  * Abstract class for post types.
+ *
+ *  Usage:
+ *
+ *  class FooPostType extends AbstractPostType {
+ *
+ *      public function get_name() {
+ *          return 'custom-post-type';
+ *      }
+ *
+ *      public function get_singular_label() {
+ *          return 'Custom Post'
+ *      }
+ *
+ *      public function get_plural_label() {
+ *          return 'Custom Posts';
+ *      }
+ *
+ *      public function get_menu_icon() {
+ *          return 'embed-post';
+ *      }
+ *
+ *      public function can_register() {
+ *          return true;
+ *      }
+ *  }
  */
 abstract class AbstractPostType extends Module {