Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-06-24 13:54:59 +02:00
Code Issues Projects Releases Wiki Activity

Docs: Improve formatting of various WP_Screen DocBlocks.

Browse Source 
See #48303.
Built from https://develop.svn.wordpress.org/trunk@46591


git-svn-id: http://core.svn.wordpress.org/trunk@46388 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2019-10-26 00:36:05 +00:00
parent 67c73ea3ea
commit 67ce1885db
2 changed files with 23 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
wp-admin/includes/class-wp-screen.php
View File

@ -14,7 +14,9 @@
*/
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
* @var string
@ -22,8 +24,10 @@ final class WP_Screen {
public $action;
/**
* 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
* @var string
@ -78,8 +82,10 @@ final class WP_Screen {
/**
* 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
* @var string
@ -88,7 +94,8 @@ final class WP_Screen {
/**
* 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
* @var string
@ -97,6 +104,7 @@ final class WP_Screen {
/**
* 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'.
*
@ -107,6 +115,7 @@ final class WP_Screen {
/**
* The taxonomy associated with the screen, if any.
*
* The 'edit-tags.php?taxonomy=category' screen has a taxonomy of 'category'.
*
* @since 3.3.0
@ -466,6 +475,7 @@ final class WP_Screen {
/**
* Set the parent information for the screen.
*
* This is called in admin-header.php after the menu parent for the screen has been determined.
*
* @since 3.3.0
@ -480,7 +490,9 @@ final class WP_Screen {
/**
* 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
*
@ -670,7 +682,9 @@ final class WP_Screen {
/**
* 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
*

2
wp-includes/version.php
View File

@ -13,7 +13,7 @@
*
* @global string $wp_version
*/
$wp_version = '5.4-alpha-46590';
$wp_version = '5.4-alpha-46591';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.