WordPress.org
Get WordPress

Make WordPress Core

Ticket #7496: 7496.phpdoc.r8616.patch

File 7496.phpdoc.r8616.patch, 10.8 KB (added by anonymized_218323, 17 years ago)

File level inline documentation for some of wp-admin files based off of r8616.

  • admin-ajax.php

     
    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 */
    214define('DOING_AJAX', true);
    315
    416require_once('../wp-load.php');
    … …  
    641653        die('0');
    642654        break;
    643655endswitch;
    644 ?>
     656?>
     657 No newline at end of file

  • admin-footer.php

     
     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 -->

  • admin-functions.php

     
    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. */
    415require_once(ABSPATH . 'wp-admin/includes/admin.php');
    5 ?>
     16?>
     17 No newline at end of file

  • admin-header.php

     
    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'));
    310if (!isset($_GET["page"])) require_once('admin.php');
    411if ( $editing ) {

  • admin-post.php

     
    11<?php
    2 define('WP_ADMIN', TRUE);
     2/**
     3 * WordPress Administration Generic POST Handler.
     4 *
     5 * @package WordPress
     6 * @subpackage Administration
     7 */
    38
     9/** We are located in WordPress Administration Panels */
     10define('WP_ADMIN', true);
     11
    412if ( defined('ABSPATH') )
    513        require_once(ABSPATH . 'wp-load.php');
    614else

  • admin.php

     
    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 */
    214define('WP_ADMIN', TRUE);
    315
    416if ( defined('ABSPATH') )
    … …  
    116128if ( !empty($_REQUEST['action']) )
    117129        do_action('admin_action_' . $_REQUEST['action']);
    118130
    119 ?>
     131?>
     132 No newline at end of file

  • async-upload.php

     
    11<?php
     2/**
     3 * Accepts file uploads from swfupload or other asynchronous upload methods.
     4 *
     5 * @package WordPress
     6 * @subpackage Administration
     7 */
    28
    3 /* This accepts file uploads from swfupload or other asynchronous upload methods.
    4 
    5 */
    6 
    79if ( defined('ABSPATH') )
    810        require_once(ABSPATH . 'wp-load.php');
    911else
    … …  
    4648        echo apply_filters("async_upload_{$type}", $id);
    4749}
    4850
    49 ?>
     51?>
     52 No newline at end of file

  • categories.php

     
    11<?php
     2/**
     3 * Categories Management Panel
     4 *
     5 * @package WordPress
     6 * @subpackage Administration
     7 */
     8
     9/** Load WordPress Bootstrap */
    210require_once('admin.php');
    311
    412$title = __('Categories');

  • comment.php

     
    11<?php
     2/**
     3 * Comment Management Panel
     4 *
     5 * @package WordPress
     6 * @subpackage Administration
     7 */
     8
     9/** Load WordPress Bootstrap */
    210require_once('admin.php');
    311
    412$parent_file = 'edit-comments.php';
    … …  
    917if ( 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 */
     25function comment_footer_die( $msg ) {  //
    1326        echo "<div class='wrap'><p>$msg</p></div>";
    1427        include('admin-footer.php');
    1528        die;
    … …  
    225238
    226239include('admin-footer.php');
    227240
    228 ?>
     241?>
     242 No newline at end of file

  • custom-header.php

     
    361361        }
    362362
    363363}
    364 ?>
     364?>
     365 No newline at end of file

  • export.php

     
    11<?php
     2/**
     3 * WordPress Export Administration Panel
     4 *
     5 * @package WordPress
     6 * @subpackage Administration
     7 */
     8
     9/** Load WordPress Bootstrap */
    210require_once ('admin.php');
     11
     12/** Load WordPress export API */
    313require_once('includes/export.php');
    414$title = __('Export');
    515$parent_file = 'edit.php';
    … …  
    4757
    4858
    4959include ('admin-footer.php');
    50 ?>
     60?>
     61 No newline at end of file

  • gears-manifest.php

     
    11<?php
     2/**
     3 * Define Gears manifest for Google Gears storage.
     4 *
     5 * @package WordPress
     6 * @subpackage Administration
     7 */
    28
     9/** Set ABSPATH for execution */
    310define( 'ABSPATH', dirname(dirname(__FILE__)) );
    411define( 'WPINC', '/wp-includes' );
    512
     13/**
     14 * @package WordPress
     15 * @subpackage Dummy
     16 */
    617function __() {}
     18
     19/**
     20 * @package WordPress
     21 * @subpackage Dummy
     22 */
    723function add_filter() {}
     24
     25/**
     26 * @package WordPress
     27 * @subpackage Dummy
     28 */
    829function attribute_escape() {}
     30
     31/**
     32 * @package WordPress
     33 * @subpackage Dummy
     34 */
    935function apply_filters() {}
     36
     37/**
     38 * @package WordPress
     39 * @subpackage Dummy
     40 */
    1041function get_option() {}
     42
     43/**
     44 * @package WordPress
     45 * @subpackage Dummy
     46 */
    1147function is_lighttpd_before_150() {}
     48
     49/**
     50 * @package WordPress
     51 * @subpackage Dummy
     52 */
    1253function add_action() {}
     54
     55/**
     56 * @package WordPress
     57 * @subpackage Dummy
     58 */
    1359function do_action_ref_array() {}
     60
     61/**
     62 * @package WordPress
     63 * @subpackage Dummy
     64 */
    1465function get_bloginfo() {}
     66
     67/**
     68 * @package WordPress
     69 * @subpackage Dummy
     70 */
    1571function is_admin() {return true;}
     72
     73/**
     74 * @package WordPress
     75 * @subpackage Dummy
     76 */
    1677function site_url() {}
     78
     79/**
     80 * @package WordPress
     81 * @subpackage Dummy
     82 */
    1783function admin_url() {}
     84
     85/**
     86 * @package WordPress
     87 * @subpackage Dummy
     88 */
    1889function wp_guess_url() {}
    1990
    2091require(ABSPATH . '/wp-includes/script-loader.php');

  • import.php

     
    11<?php
     2/**
     3 * Import WordPress Administration Panel
     4 *
     5 * @package WordPress
     6 * @subpackage Administration
     7 */
     8
     9/** Load WordPress Bootstrap */
    210require_once ('admin.php');
    311$title = __('Import');
    412$parent_file = 'edit.php';

  • includes/admin.php

     
    11<?php
     2/**
     3 * Includes all of the WordPress Administration API files.
     4 *
     5 * @package WordPress
     6 * @subpackage Administration
     7 */
    28
     9/** WordPress Bookmark Administration API */
    310require_once(ABSPATH . 'wp-admin/includes/bookmark.php');
     11
     12/** WordPress Comment Administration API */
    413require_once(ABSPATH . 'wp-admin/includes/comment.php');
     14
     15/** WordPress Administration File API */
    516require_once(ABSPATH . 'wp-admin/includes/file.php');
     17
     18/** WordPress Image Administration API */
    619require_once(ABSPATH . 'wp-admin/includes/image.php');
     20
     21/** WordPress Media Administration API */
    722require_once(ABSPATH . 'wp-admin/includes/media.php');
     23
     24/** WordPress Import Administration API */
    825require_once(ABSPATH . 'wp-admin/includes/import.php');
     26
     27/** WordPress Misc Administration API */
    928require_once(ABSPATH . 'wp-admin/includes/misc.php');
     29
     30/** WordPress Plugin Administration API */
    1031require_once(ABSPATH . 'wp-admin/includes/plugin.php');
     32
     33/** WordPress Post Administration API */
    1134require_once(ABSPATH . 'wp-admin/includes/post.php');
     35
     36/** WordPress Taxonomy Administration API */
    1237require_once(ABSPATH . 'wp-admin/includes/taxonomy.php');
     38
     39/** WordPress Template Administration API */
    1340require_once(ABSPATH . 'wp-admin/includes/template.php');
     41
     42/** WordPress Theme Administration API */
    1443require_once(ABSPATH . 'wp-admin/includes/theme.php');
     44
     45/** WordPress User Administration API */
    1546require_once(ABSPATH . 'wp-admin/includes/user.php');
     47
     48/** WordPress Update Administration API */
    1649require_once(ABSPATH . 'wp-admin/includes/update.php');
    1750
     51/** WordPress Registration API */
    1852require_once(ABSPATH . WPINC . '/registration.php');
    1953
    20 ?>
     54?>
     55 No newline at end of file

  • index-extra.php

     
    11<?php
     2/**
     3 * Handle default dashboard widgets options AJAX.
     4 *
     5 * @package WordPress
     6 * @subpackage Administration
     7 */
     8
     9/** Load WordPress Bootstrap */
    210require_once('admin.php');
     11
     12/** Load WordPress Administration Dashboard API */
    313require( 'includes/dashboard.php' );
     14
     15/** Load Magpie RSS API or custom RSS API */
    416require_once (ABSPATH . WPINC . '/rss.php');
    517
    618@header('Content-Type: ' . get_option('html_type') . '; charset=' . get_option('blog_charset'));
    … …  
    2537
    2638}
    2739
    28 ?>
     40?>
     41 No newline at end of file

  • index.php

     
    11<?php
     2/**
     3 * Dashboard Administration Panel
     4 *
     5 * @package WordPress
     6 * @subpackage Administration
     7 */
    28
     9/** Load WordPress Bootstrap */
    310require_once('admin.php');
    411
     12/** Load WordPress dashboard API */
    513require_once(ABSPATH . 'wp-admin/includes/dashboard.php');
    614
    715wp_dashboard_setup();
    816
     17/**
     18 * Display dashboard widget custom JavaScript.
     19 *
     20 * @since unknown
     21 */
    922function index_js() {
    1023?>
    1124<script type="text/javascript">