Skip to content

Docs: Fix inline documentation standards in wp-admin #10788

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
huzaifaalmesbah wants to merge 1 commit into
base: trunk
Choose a base branch
from
+14 −11
Open

Docs: Fix inline documentation standards in wp-admin #10788

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/wp-admin/includes/class-wp-importer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
<?php
/**
* WP_Importer base class
*
* @package WordPress
* @subpackage Importer
*/
#[AllowDynamicProperties]
class WP_Importer {
Expand Down
8 changes: 4 additions & 4 deletions src/wp-admin/includes/class-wp-list-table.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Administration API: WP_List_Table class
* Administration API: WP_List_Table class.
*
* @package WordPress
* @subpackage List_Table
Expand Down Expand Up @@ -80,14 +80,14 @@ class WP_List_Table {
protected $_column_headers;

/**
* {@internal Missing Summary}
* List of properties that are back-filled for backward compatibility.
*
* @var array
*/
protected $compat_fields = array( '_args', '_pagination_args', 'screen', '_actions', '_pagination' );

/**
* {@internal Missing Summary}
* List of methods that are back-filled for backward compatibility.
*
* @var array
*/
Expand Down Expand Up @@ -280,7 +280,7 @@ public function __call( $name, $arguments ) {
}

/**
* Checks the current user's permissions
* Checks the current user's permissions.
Copy link
Member

@mukeshpanchal27 mukeshpanchal27 Jan 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

*
* @since 3.1.0
* @abstract
Expand Down
6 changes: 3 additions & 3 deletions src/wp-admin/includes/media.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ function media_upload_tabs() {
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param array $tabs
* @param array $tabs Associative array of default tab names.
* @return array $tabs with gallery if post has image attachment
*/
function update_gallery_tab( $tabs ) {
Expand Down Expand Up @@ -71,7 +71,7 @@ function update_gallery_tab( $tabs ) {
*
* @since 2.5.0
*
* @global string $redir_tab
* @global string $redir_tab The name of the tab to redirect to.
*/
function the_media_upload_tabs() {
global $redir_tab;
Expand Down Expand Up @@ -527,7 +527,7 @@ function media_handle_sideload( $file_array, $post_id = 0, $desc = null, $post_d
* @since 5.3.0 Formalized the existing and already documented `...$args` parameter
* by adding it to the function signature.
*
* @global string $body_id
* @global string $body_id The ID attribute value for the body element.
*
* @param callable $content_func Function that outputs the content.
* @param mixed ...$args Optional additional parameters to pass to the callback function when it's called.
Expand Down
8 changes: 4 additions & 4 deletions src/wp-admin/includes/user.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -482,7 +482,7 @@ function wp_revoke_user( $id ) {
/**
* @since 2.8.0
*
* @global int $user_ID
* @global int $user_ID Current user ID.
*
* @param false $errors Deprecated.
*/
Expand All @@ -505,8 +505,8 @@ function default_password_nag_handler( $errors = false ) {
/**
* @since 2.8.0
*
* @param int $user_ID
* @param WP_User $old_data
* @param int $user_ID User ID.
* @param WP_User $old_data The user object before the update.
*/
function default_password_nag_edit_user( $user_ID, $old_data ) {
// Short-circuit it.
Expand Down Expand Up @@ -602,7 +602,7 @@ function use_ssl_preference( $user ) {
/**
* @since MU (3.0.0)
*
* @param string $text
* @param string $text The email body text.
* @return string User site invitation email message.
*/
function admin_created_user_email( $text ) {
Expand Down
Loading