Changeset 1298

Timestamp:

02/24/2015 07:31:13 AM (10 years ago)

Author:

coffee2code

Message:

developer.wordpress.org: Add DocBlocks to Dashicons code samples.

Fixes #877.
Props DrewAPicture.

File:

• sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/page-dashicons.php (modified) (2 diffs)

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/page-dashicons.php

@@ -336 +336 @@
 
 <pre>&lt;?php
-add_action( 'init', 'create_post_type' );
-//Registers the Product's post type
-function create_post_type() {
+/**
+ * Register the Product post type with a Dashicon.
+ *
+ * @see register_post_type()
+ */
+function wpdocs_create_post_type() {
     register_post_type( 'acme_product',
         array(
             'labels' => array(
-                'name' => __( 'Products' ),
-                'singular_name' => __( 'Product' )
+                'name'          => __( 'Products', 'textdomain' ),
+                'singular_name' => __( 'Product', 'textdomain' )
             ),
-            'public' => true,
+            'public'      => true,
             'has_archive' => true,
-            'menu_icon' => 'dashicons-products',
+            'menu_icon'   => 'dashicons-products',
         )
     );
 }
+add_action( 'init', 'wpdocs_create_post_type', 0 );
 </pre>
 
@@ -359 +363 @@
 
 <pre>&lt;?php
-function add_my_custom_menu() {
-    //add an item to the menu
+/**
+ * Register a menu page with a Dashicon.
+ *
+ * @see add_menu_page()
+ */
+function wpdocs_add_my_custom_menu() {
+    // Add an item to the menu.
     add_menu_page (
-        'My Page',
-        'My Title',
+        __( 'My Page', 'textdomain' ),
+        __( 'My Title', 'textdomain' ),
         'manage_options',
         'my-page',