Skip to content

Commit a70e1a3

Browse files
ryanborenryanboren
committed
WP-Admin File Level Inline Documentation from santosj. see WordPress#7496
git-svn-id: https://develop.svn.wordpress.org/trunk@8618 602fd350-edb4-49c9-b593-d223f7449a82
1 parent 5a8b37f commit a70e1a3

16 files changed

Lines changed: 246 additions & 17 deletions

‎wp-admin/admin-ajax.php‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,16 @@
11
<?php
2+
/**
3+
* WordPress AJAX Process Execution.
4+
*
5+
* @package WordPress
6+
* @subpackage Administration
7+
*/
8+
9+
/**
10+
* Executing AJAX process.
11+
*
12+
* @since unknown
13+
*/
214
define('DOING_AJAX', true);
315

416
require_once('../wp-load.php');
@@ -641,4 +653,4 @@
641653
die('0');
642654
break;
643655
endswitch;
644-
?>
656+
?>

‎wp-admin/admin-footer.php‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
<?php
2+
/**
3+
* WordPress Administration Template Footer
4+
*
5+
* @package WordPress
6+
* @subpackage Administration
7+
*/
8+
?>
19
</div><!-- wpbody -->
210
</div><!-- wpcontent -->
311
</div><!-- wpwrap -->

‎wp-admin/admin-functions.php‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
<?php
2-
// Deprecated. Use includes/admin.php.
2+
/**
3+
* Administration Functions
4+
*
5+
* This file is deprecated, use 'wp-admin/includes/admin.php' instead.
6+
*
7+
* @deprecated 2.5
8+
* @package WordPress
9+
* @subpackage Administration
10+
*/
11+
312
_deprecated_file( basename(__FILE__), '2.5', 'wp-admin/includes/admin.php' );
13+
14+
/** WordPress Administration API: Includes all Administration functions. */
415
require_once(ABSPATH . 'wp-admin/includes/admin.php');
5-
?>
16+
?>

‎wp-admin/admin-header.php‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
<?php
2+
/**
3+
* WordPress Administration Template Header
4+
*
5+
* @package WordPress
6+
* @subpackage Administration
7+
*/
8+
29
@header('Content-Type: ' . get_option('html_type') . '; charset=' . get_option('blog_charset'));
310
if (!isset($_GET["page"])) require_once('admin.php');
411
if ( $editing ) {

‎wp-admin/admin-post.php‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
<?php
2-
define('WP_ADMIN', TRUE);
2+
/**
3+
* WordPress Administration Generic POST Handler.
4+
*
5+
* @package WordPress
6+
* @subpackage Administration
7+
*/
8+
9+
/** We are located in WordPress Administration Panels */
10+
define('WP_ADMIN', true);
311

412
if ( defined('ABSPATH') )
513
require_once(ABSPATH . 'wp-load.php');

‎wp-admin/admin.php‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,16 @@
11
<?php
2+
/**
3+
* WordPress Administration Bootstrap
4+
*
5+
* @package WordPress
6+
* @subpackage Administration
7+
*/
8+
9+
/**
10+
* In WordPress Administration Panels
11+
*
12+
* @since unknown
13+
*/
214
define('WP_ADMIN', TRUE);
315

416
if ( defined('ABSPATH') )
@@ -116,4 +128,4 @@
116128
if ( !empty($_REQUEST['action']) )
117129
do_action('admin_action_' . $_REQUEST['action']);
118130

119-
?>
131+
?>

‎wp-admin/async-upload.php‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
<?php
2-
3-
/* This accepts file uploads from swfupload or other asynchronous upload methods.
4-
5-
*/
2+
/**
3+
* Accepts file uploads from swfupload or other asynchronous upload methods.
4+
*
5+
* @package WordPress
6+
* @subpackage Administration
7+
*/
68

79
if ( defined('ABSPATH') )
810
require_once(ABSPATH . 'wp-load.php');
@@ -46,4 +48,4 @@
4648
echo apply_filters("async_upload_{$type}", $id);
4749
}
4850

49-
?>
51+
?>

‎wp-admin/categories.php‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
11
<?php
2+
/**
3+
* Categories Management Panel
4+
*
5+
* @package WordPress
6+
* @subpackage Administration
7+
*/
8+
9+
/** Load WordPress Bootstrap */
210
require_once('admin.php');
311

412
$title = __('Categories');

‎wp-admin/comment.php‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
11
<?php
2+
/**
3+
* Comment Management Panel
4+
*
5+
* @package WordPress
6+
* @subpackage Administration
7+
*/
8+
9+
/** Load WordPress Bootstrap */
210
require_once('admin.php');
311

412
$parent_file = 'edit-comments.php';
@@ -9,7 +17,12 @@
917
if ( isset( $_POST['deletecomment'] ) )
1018
$action = 'deletecomment';
1119

12-
function comment_footer_die( $msg ) { // $msg is assumed to contain HTML and be sanitized
20+
/**
21+
* Display error message at bottom of comments.
22+
*
23+
* @param string $msg Error Message. Assumed to contain HTML and be sanitized.
24+
*/
25+
function comment_footer_die( $msg ) { //
1326
echo "<div class='wrap'><p>$msg</p></div>";
1427
include('admin-footer.php');
1528
die;
@@ -225,4 +238,4 @@ function comment_footer_die( $msg ) { // $msg is assumed to contain HTML and be
225238

226239
include('admin-footer.php');
227240

228-
?>
241+
?>

‎wp-admin/custom-header.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -361,4 +361,4 @@ function admin_page() {
361361
}
362362

363363
}
364-
?>
364+
?>

0 commit comments

Comments
 (0)