Changeset 46591 for trunk/src/wp-admin/includes/class-wp-screen.php

Timestamp:

10/26/2019 12:34:10 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve formatting of various WP_Screen DocBlocks.

See #48303.

File:

• trunk/src/wp-admin/includes/class-wp-screen.php (modified) (9 diffs)

trunk/src/wp-admin/includes/class-wp-screen.php

@@ -15 +15 @@
 final class WP_Screen {
     /**
-     * Any action associated with the screen. 'add' for *-add.php and *-new.php screens. Empty otherwise.
+     * Any action associated with the screen.
+     *
+     * 'add' for *-add.php and *-new.php screens. Empty otherwise.
      *
      * @since 3.3.0
@@ -23 +25 @@
 
     /**
-     * The base type of the screen. This is typically the same as $id but with any post types and taxonomies stripped.
-     * For example, for an $id of 'edit-post' the base is 'edit'.
+     * The base type of the screen.
+     *
+     * This is typically the same as `$id` but with any post types and taxonomies stripped.
+     * For example, for an `$id` of 'edit-post' the base is 'edit'.
      *
      * @since 3.3.0
@@ -79 +83 @@
     /**
      * The base menu parent.
-     * This is derived from $parent_file by removing the query string and any .php extension.
-     * $parent_file values of 'edit.php?post_type=page' and 'edit.php?post_type=post' have a $parent_base of 'edit'.
+     *
+     * This is derived from `$parent_file` by removing the query string and any .php extension.
+     * `$parent_file` values of 'edit.php?post_type=page' and 'edit.php?post_type=post'
+     * have a `$parent_base` of 'edit'.
      *
      * @since 3.3.0
@@ -89 +95 @@
     /**
      * The parent_file for the screen per the admin menu system.
-     * Some $parent_file values are 'edit.php?post_type=page', 'edit.php', and 'options-general.php'.
+     *
+     * Some `$parent_file` values are 'edit.php?post_type=page', 'edit.php', and 'options-general.php'.
      *
      * @since 3.3.0
@@ -98 +105 @@
     /**
      * The post type associated with the screen, if any.
+     *
      * The 'edit.php?post_type=page' screen has a post type of 'page'.
      * The 'edit-tags.php?taxonomy=$taxonomy&post_type=page' screen has a post type of 'page'.
@@ -108 +116 @@
     /**
      * The taxonomy associated with the screen, if any.
+     *
      * The 'edit-tags.php?taxonomy=category' screen has a taxonomy of 'category'.
      *
@@ -467 +476 @@
     /**
      * Set the parent information for the screen.
+     *
      * This is called in admin-header.php after the menu parent for the screen has been determined.
      *
@@ -481 +491 @@
     /**
      * Adds an option for the screen.
-     * Call this in template files after admin.php is loaded and before admin-header.php is loaded to add screen options.
+     *
+     * Call this in template files after admin.php is loaded and before admin-header.php is loaded
+     * to add screen options.
      *
      * @since 3.3.0
@@ -671 +683 @@
     /**
      * Add a sidebar to the contextual help for the screen.
-     * Call this in template files after admin.php is loaded and before admin-header.php is loaded to add a sidebar to the contextual help.
+     *
+     * Call this in template files after admin.php is loaded and before admin-header.php is loaded
+     * to add a sidebar to the contextual help.
      *
      * @since 3.3.0