WordPress.org
Get WordPress

Make WordPress Core

Changeset 8645


Ignore:
Timestamp:
08/14/2008 06:30:38 AM (16 years ago)
Author:
westi
Message:

phpdoc for wp-admin. See #7496 props santosj.

Location:
trunk/wp-admin
Files:
46 edited

Legend:

Unmodified
Added
Removed

  • trunk/wp-admin/admin-header.php

    r8618 r8645  
    1919$ie6_no_scrollbar = true;
    2020
     21/**
     22 * Append 'minwidth' to value.
     23 *
     24 * @param mixed $c
     25 * @return string
     26 */
    2127function add_minwidth($c) {
    2228    return $c . 'minwidth ';

  • trunk/wp-admin/import/blogger.php

    r7713 r8645  
    11<?php
    2 
    3 define( 'MAX_RESULTS',        50 ); // How many records per GData query
    4 define( 'MAX_EXECUTION_TIME', 20 ); // How many seconds to let the script run
    5 define( 'STATUS_INTERVAL',     3 ); // How many seconds between status bar updates
    6 
     2/**
     3 * Blogger Importer
     4 *
     5 * @package WordPress
     6 * @subpackage Importer
     7 */
     8
     9/**
     10 * How many records per GData query
     11 *
     12 * @package WordPress
     13 * @subpackage Blogger_Import
     14 * @var int
     15 * @since unknown
     16 */
     17define( 'MAX_RESULTS',        50 );
     18
     19/**
     20 * How many seconds to let the script run
     21 *
     22 * @package WordPress
     23 * @subpackage Blogger_Import
     24 * @var int
     25 * @since unknown
     26 */
     27define( 'MAX_EXECUTION_TIME', 20 );
     28
     29/**
     30 * How many seconds between status bar updates
     31 *
     32 * @package WordPress
     33 * @subpackage Blogger_Import
     34 * @var int
     35 * @since unknown
     36 */
     37define( 'STATUS_INTERVAL',     3 );
     38
     39/**
     40 * Blogger Importer class
     41 *
     42 * @since unknown
     43 */
    744class Blogger_Import {
    845

  • trunk/wp-admin/import/blogware.php

    r7104 r8645  
    11<?php
    2 
    3 /* By Shayne Sweeney - http://www.theshayne.com/ */
    4 
     2/**
     3 * Blogware XML Importer
     4 *
     5 * @package WordPress
     6 * @subpackage Importer
     7 * @author Shayne Sweeney
     8 * @link http://www.theshayne.com/
     9 */
     10
     11/**
     12 * Blogware XML Importer class
     13 *
     14 * Extract posts from Blogware XML export file into your blog.
     15 *
     16 * @since unknown
     17 */
    518class BW_Import {
    619

  • trunk/wp-admin/import/btt.php

    r7071 r8645  
    11<?php
     2/**
     3 * BunnyTags Plugin Tag Importer
     4 *
     5 * @package WordPress
     6 * @subpackage Importer
     7 */
    28
     9/**
     10 * BunnyTags Plugin tag converter
     11 *
     12 * This will process the BunnyTags plugin tags and convert them to the WordPress
     13 * 2.3 taxonomy.
     14 *
     15 * @since unknown
     16 */
    317class BunnyTags_Import {
    418

  • trunk/wp-admin/import/dotclear.php

    r7645 r8645  
    11<?php
    2 /*
    3  * DotClear import plugin
    4  * by Thomas Quinot - http://thomas.quinot.org/
     2/**
     3 * DotClear Importer
     4 *
     5 * @package WordPress
     6 * @subpackage Importer
     7 * @author Thomas Quinot
     8 * @link http://thomas.quinot.org/
    59 */
    610
    … …  
    1115if(!function_exists('get_comment_count'))
    1216{
     17    /**
     18     * Get the comment count for posts.
     19     *
     20     * @package WordPress
     21     * @subpackage Dotclear_Import
     22     *
     23     * @param int $post_ID Post ID
     24     * @return int
     25     */
    1326    function get_comment_count($post_ID)
    1427    {
    … …  
    2033if(!function_exists('link_exists'))
    2134{
     35    /**
     36     * Check whether link already exists.
     37     *
     38     * @package WordPress
     39     * @subpackage Dotclear_Import
     40     *
     41     * @param string $linkname
     42     * @return int
     43     */
    2244    function link_exists($linkname)
    2345    {
    … …  
    4163//
    4264
     65/**
     66 * @package WordPress
     67 * @subpackage Dotclear_Import
     68 *
     69 * @param string $char
     70 * @return string
     71 */
    4372function valid_1byte($char) {
    4473    if(!is_int($char)) return false;
    … …  
    4675}
    4776
     77/**
     78 * @package WordPress
     79 * @subpackage Dotclear_Import
     80 *
     81 * @param string $char
     82 * @return string
     83 */
    4884function valid_2byte($char) {
    4985    if(!is_int($char)) return false;
    … …  
    5187}
    5288
     89/**
     90 * @package WordPress
     91 * @subpackage Dotclear_Import
     92 *
     93 * @param string $char
     94 * @return string
     95 */
    5396function valid_3byte($char) {
    5497    if(!is_int($char)) return false;
    … …  
    5699}
    57100
     101/**
     102 * @package WordPress
     103 * @subpackage Dotclear_Import
     104 *
     105 * @param string $char
     106 * @return string
     107 */
    58108function valid_4byte($char) {
    59109    if(!is_int($char)) return false;
    … …  
    61111}
    62112
     113/**
     114 * @package WordPress
     115 * @subpackage Dotclear_Import
     116 *
     117 * @param string $char
     118 * @return string
     119 */
    63120function valid_nextbyte($char) {
    64121    if(!is_int($char)) return false;
    … …  
    66123}
    67124
     125/**
     126 * @package WordPress
     127 * @subpackage Dotclear_Import
     128 *
     129 * @param string $string
     130 * @return string
     131 */
    68132function valid_utf8($string) {
    69133    $len = strlen($string);
    … …  
    93157}
    94158
     159/**
     160 * @package WordPress
     161 * @subpackage Dotclear_Import
     162 *
     163 * @param string $s
     164 * @return string
     165 */
    95166function csc ($s) {
    96167    if (valid_utf8 ($s)) {
    … …  
    101172}
    102173
     174/**
     175 * @package WordPress
     176 * @subpackage Dotclear_Import
     177 *
     178 * @param string $s
     179 * @return string
     180 */
    103181function textconv ($s) {
    104182    return csc (preg_replace ('|(?<!<br />)\s*\n|', ' ', $s));
    … …  
    106184
    107185/**
    108     The Main Importer Class
    109 **/
     186 * Dotclear Importer class
     187 *
     188 * Will process the WordPress eXtended RSS files that you upload from the export
     189 * file.
     190 *
     191 * @package WordPress
     192 * @subpackage Importer
     193 *
     194 * @since unknown
     195 */
    110196class Dotclear_Import {
    111197
    … …  
    743829
    744830$dc_import = new Dotclear_Import();
     831
    745832register_importer('dotclear', __('DotClear'), __('Import categories, users, posts, comments, and links from a DotClear blog.'), array ($dc_import, 'dispatch'));
     833
    746834?>

  • trunk/wp-admin/import/greymatter.php

    r7883 r8645  
    11<?php
    2 
     2/**
     3 * GreyMatter Importer
     4 *
     5 * @package WordPress
     6 * @subpackage Importer
     7 */
     8
     9/**
     10 * GreyMatter Importer class
     11 *
     12 * Basic GreyMatter to WordPress importer, will import posts, comments, and
     13 * posts karma.
     14 *
     15 * @since unknown
     16 */
    317class GM_Import {
    418

  • trunk/wp-admin/import/jkw.php

    r7071 r8645  
    11<?php
     2/**
     3 * Jeromes Keyword Plugin Importer
     4 *
     5 * @package WordPress
     6 * @subpackage Importer
     7 */
    28
     9/**
     10 * Jeromes Keyword Plugin Importer class
     11 *
     12 * Will convert Jeromes Keyword Plugin tags to WordPress taxonomy tags.
     13 *
     14 * @since 2.3
     15 */
    316class JeromesKeyword_Import {
    417

  • trunk/wp-admin/import/livejournal.php

    r7104 r8645  
    11<?php
     2/**
     3 * LiveJournal Importer
     4 *
     5 * @package WordPress
     6 * @subpackage Importer
     7 */
    28
     9/**
     10 * LiveJournal Importer class
     11 *
     12 * Imports your LiveJournal XML exported file into WordPress.
     13 *
     14 * @since unknown
     15 */
    316class LJ_Import {
    417

  • trunk/wp-admin/import/mt.php

    r8600 r8645  
    11<?php
    2 
     2/**
     3 * Movable Type and Typepad Importer
     4 *
     5 * @package WordPress
     6 * @subpackage Importer
     7 */
     8
     9/**
     10 * Moveable Type and Typepad Importer class
     11 *
     12 * Upload your exported Movable Type or Typepad entries into WordPress.
     13 *
     14 * @since unknown
     15 */
    316class MT_Import {
    417

  • trunk/wp-admin/import/rss.php

    r7072 r8645  
    11<?php
     2/**
     3 * RSS Importer
     4 *
     5 * @package WordPress
     6 * @subpackage Importer
     7 */
    28
     9/**
     10 * RSS Importer
     11 *
     12 * Will process a RSS feed for importing posts into WordPress. This is a very
     13 * limited importer and should only be used as the last resort, when no other
     14 * importer is available.
     15 *
     16 * @since unknown
     17 */
    318class RSS_Import {
    419

  • trunk/wp-admin/import/stp.php

    r7125 r8645  
    11<?php
     2/**
     3 * Simple Tags Plugin Importer
     4 *
     5 * @package WordPress
     6 * @subpackage Importer
     7 */
     8
     9/**
     10 * Simple Tags Plugin Tags converter class.
     11 *
     12 * Will convert Simple Tags Plugin tags over to the WordPress 2.3 taxonomy.
     13 *
     14 * @since unknown
     15 */
    216class STP_Import {
    317    function header()  {

  • trunk/wp-admin/import/textpattern.php

    r7645 r8645  
    11<?php
    22/**
    3     Add These Functions to make our lives easier
    4 **/
     3 * TextPattern Importer
     4 *
     5 * @package WordPress
     6 * @subpackage Importer
     7 */
    58
    69if(!function_exists('get_comment_count'))
    710{
     11    /**
     12     * Get the comment count for posts.
     13     *
     14     * @package WordPress
     15     * @subpackage Textpattern_Import
     16     *
     17     * @param int $post_ID Post ID
     18     * @return int
     19     */
    820    function get_comment_count($post_ID)
    921    {
    … …  
    1527if(!function_exists('link_exists'))
    1628{
     29    /**
     30     * Check whether link already exists.
     31     *
     32     * @package WordPress
     33     * @subpackage Textpattern_Import
     34     *
     35     * @param string $linkname
     36     * @return int
     37     */
    1738    function link_exists($linkname)
    1839    {
    … …  
    2344
    2445/**
    25     The Main Importer Class
    26 **/
     46 * TextPattern Importer Class
     47 *
     48 * @since unknown
     49 */
    2750class Textpattern_Import {
    2851
    … …  
    671694
    672695$txp_import = new Textpattern_Import();
     696
    673697register_importer('textpattern', __('Textpattern'), __('Import categories, users, posts, comments, and links from a Textpattern blog.'), array ($txp_import, 'dispatch'));
     698
    674699?>

  • trunk/wp-admin/import/utw.php

    r7071 r8645  
    11<?php
    2 
     2/**
     3 * The Ultimate Tag Warrior Importer.
     4 *
     5 * @package WordPress
     6 * @subpackage Importer
     7 */
     8
     9/**
     10 * Ultimate Tag Warrior Converter to 2.3 taxonomy.
     11 *
     12 * This converts the Ultimate Tag Warrior tags to the 2.3 WordPress taxonomy.
     13 *
     14 * @since 2.3.0
     15 */
    316class UTW_Import {
    417

  • trunk/wp-admin/import/wordpress.php

    r8600 r8645  
    11<?php
    2 
     2/**
     3 * WordPress Importer
     4 *
     5 * @package WordPress
     6 * @subpackage Importer
     7 */
     8
     9/**
     10 * WordPress Importer
     11 *
     12 * Will process the WordPress eXtended RSS files that you upload from the export
     13 * file.
     14 *
     15 * @since unknown
     16 */
    317class WP_Import {
    418
    … …  
    747761}
    748762
     763/**
     764 * Register WordPress Importer
     765 *
     766 * @since unknown
     767 * @var WP_Import
     768 * @name $wp_import
     769 */
    749770$wp_import = new WP_Import();
    750771

  • trunk/wp-admin/import/wp-cat2tag.php

    r8600 r8645  
    11<?php
    2 
     2/**
     3 * WordPress Categories to Tags Converter.
     4 *
     5 * @package WordPress
     6 * @subpackage Importer
     7 */
     8
     9/**
     10 * WordPress categories to tags converter class.
     11 *
     12 * Will convert WordPress categories to tags, removing the category after the
     13 * process is complete and updating all posts to switch to the tag.
     14 *
     15 * @since unknown
     16 */
    317class WP_Categories_to_Tags {
    418    var $categories_to_convert = array();

  • trunk/wp-admin/includes/class-ftp-pure.php

    r7257 r8645  
    44 *
    55 * @package PemFTP
     6 * @since 2.5
     7 *
     8 * @version 1.0
     9 * @copyright Alexey Dotsenko
     10 * @author Alexey Dotsenko
     11 * @link http://www.phpclasses.org/browse/package/1743.html Site
     12 * @license LGPL License http://www.opensource.org/licenses/lgpl-license.html
     13 */
     14
     15/**
     16 * FTP implementation using fsockopen to connect.
     17 *
     18 * @package PemFTP
     19 * @subpackage Pure
    620 * @since 2.5
    721 *
    … …  
    173187    }
    174188}
     189
    175190?>

  • trunk/wp-admin/includes/class-ftp-sockets.php

    r7257 r8645  
    44 *
    55 * @package PemFTP
     6 * @since 2.5
     7 *
     8 * @version 1.0
     9 * @copyright Alexey Dotsenko
     10 * @author Alexey Dotsenko
     11 * @link http://www.phpclasses.org/browse/package/1743.html Site
     12 * @license LGPL License http://www.opensource.org/licenses/lgpl-license.html
     13 */
     14
     15/**
     16 * Socket Based FTP implementation
     17 *
     18 * @package PemFTP
     19 * @subpackage Socket
    620 * @since 2.5
    721 *

  • trunk/wp-admin/includes/class-ftp.php

    r7327 r8645  
    1212 * @license LGPL License http://www.opensource.org/licenses/lgpl-license.html
    1313 */
     14
     15/**
     16 * Defines the newline characters, if not defined already.
     17 *
     18 * This can be redefined.
     19 *
     20 * @since 2.5
     21 * @var string
     22 */
    1423if(!defined('CRLF')) define('CRLF',"\r\n");
     24
     25/**
     26 * Sets whatever to autodetect ASCII mode.
     27 *
     28 * This can be redefined.
     29 *
     30 * @since 2.5
     31 * @var int
     32 */
    1533if(!defined("FTP_AUTOASCII")) define("FTP_AUTOASCII", -1);
     34
     35/**
     36 *
     37 * This can be redefined.
     38 * @since 2.5
     39 * @var int
     40 */
    1641if(!defined("FTP_BINARY")) define("FTP_BINARY", 1);
     42
     43/**
     44 *
     45 * This can be redefined.
     46 * @since 2.5
     47 * @var int
     48 */
    1749if(!defined("FTP_ASCII")) define("FTP_ASCII", 0);
    18 if(!defined('FTP_FORCE')) define('FTP_FORCE', TRUE);
     50
     51/**
     52 * Whether to force FTP.
     53 *
     54 * This can be redefined.
     55 *
     56 * @since 2.5
     57 * @var bool
     58 */
     59if(!defined('FTP_FORCE')) define('FTP_FORCE', true);
     60
     61/**
     62 * @since 2.5
     63 * @var string
     64 */
    1965define('FTP_OS_Unix','u');
     66
     67/**
     68 * @since 2.5
     69 * @var string
     70 */
    2071define('FTP_OS_Windows','w');
     72
     73/**
     74 * @since 2.5
     75 * @var string
     76 */
    2177define('FTP_OS_Mac','m');
    2278
     79/**
     80 * PemFTP base class
     81 *
     82 */
    2383class ftp_base {
    2484    /* Public variables */
    … …  
    839899    if(!@dl($prefix . 'sockets.' . PHP_SHLIB_SUFFIX)) $mod_sockets=FALSE;
    840900}
     901
    841902require_once "class-ftp-".($mod_sockets?"sockets":"pure").".php";
    842903?>

  • trunk/wp-admin/includes/class-pclzip.php

    r7314 r8645  
    11<?php
    2 // --------------------------------------------------------------------------------
    3 // PhpConcept Library - Zip Module 2.5
    4 // --------------------------------------------------------------------------------
    5 // License GNU/LGPL - Vincent Blavet - March 2006
    6 // http://www.phpconcept.net
    7 // --------------------------------------------------------------------------------
    8 //
    9 // Presentation :
    10 //   PclZip is a PHP library that manage ZIP archives.
    11 //   So far tests show that archives generated by PclZip are readable by
    12 //   WinZip application and other tools.
    13 //
    14 // Description :
    15 //   See readme.txt and http://www.phpconcept.net
    16 //
    17 // Warning :
    18 //   This library and the associated files are non commercial, non professional
    19 //   work.
    20 //   It should not have unexpected results. However if any damage is caused by
    21 //   this software the author can not be responsible.
    22 //   The use of this software is at the risk of the user.
    23 //
    24 // --------------------------------------------------------------------------------
    25 // $Id: pclzip.lib.php,v 1.44 2006/03/08 21:23:59 vblavet Exp $
    26 // --------------------------------------------------------------------------------
    27 
    28   // ----- Constants
    29   define( 'PCLZIP_READ_BLOCK_SIZE', 2048 );
    30 
    31   // ----- File list separator
    32   // In version 1.x of PclZip, the separator for file list is a space
    33   // (which is not a very smart choice, specifically for windows paths !).
    34   // A better separator should be a comma (,). This constant gives you the
    35   // abilty to change that.
    36   // However notice that changing this value, may have impact on existing
    37   // scripts, using space separated filenames.
    38   // Recommanded values for compatibility with older versions :
    39   //define( 'PCLZIP_SEPARATOR', ' ' );
    40   // Recommanded values for smart separation of filenames.
    41   define( 'PCLZIP_SEPARATOR', ',' );
    42 
    43   // ----- Error configuration
    44   // 0 : PclZip Class integrated error handling
    45   // 1 : PclError external library error handling. By enabling this
    46   //     you must ensure that you have included PclError library.
    47   // [2,...] : reserved for futur use
    48   define( 'PCLZIP_ERROR_EXTERNAL', 0 );
     2/**
     3 * PhpConcept Library - Zip Module 2.5
     4 *
     5 * Presentation :
     6 *   PclZip is a PHP library that manage ZIP archives.
     7 *   So far tests show that archives generated by PclZip are readable by
     8 *   WinZip application and other tools.
     9 *
     10 * Warning :
     11 *   This library and the associated files are non commercial, non professional
     12 *   work.
     13 *   It should not have unexpected results. However if any damage is caused by
     14 *   this software the author can not be responsible.
     15 *   The use of this software is at the risk of the user.
     16 *
     17 * @package External
     18 * @subpackage PclZip
     19 *
     20 * @license License GNU/LGPL
     21 * @copyright March 2006 Vincent Blavet
     22 * @author Vincent Blavet
     23 * @link http://www.phpconcept.net
     24 * @version $Id: pclzip.lib.php,v 1.44 2006/03/08 21:23:59 vblavet Exp $
     25 */
     26
     27/**
     28 * The read block size for reading zip files.
     29 *
     30 * @since 2.5
     31 */
     32define( 'PCLZIP_READ_BLOCK_SIZE', 2048 );
     33
     34/**
     35 * File list separator
     36 *
     37 * In version 1.x of PclZip, the separator for file list is a space(which is not
     38 * a very smart choice, specifically for windows paths !). A better separator
     39 * should be a comma (,). This constant gives you the abilty to change that.
     40 *
     41 * However notice that changing this value, may have impact on existing scripts,
     42 * using space separated filenames. Recommanded values for compatibility with
     43 * older versions :
     44 * <code>define( 'PCLZIP_SEPARATOR', ' ' );</code>
     45 * Recommanded values for smart separation of filenames.
     46 */
     47define( 'PCLZIP_SEPARATOR', ',' );
     48
     49/**
     50 * Error configuration
     51 *
     52 * 0 : PclZip Class integrated error handling
     53 * 1 : PclError external library error handling. By enabling this you must
     54 *     ensure that you have included PclError library.
     55 * [2,...] : reserved for future use
     56 */
     57define( 'PCLZIP_ERROR_EXTERNAL', 0 );
    4958
    5059  // ----- Optional static temporary directory
    … …  
    138147  define( 'PCLZIP_CB_PRE_ADD', 78003 );
    139148  define( 'PCLZIP_CB_POST_ADD', 78004 );
    140   /* For futur use
     149  /* For future use
    141150  define( 'PCLZIP_CB_PRE_LIST', 78005 );
    142151  define( 'PCLZIP_CB_POST_LIST', 78006 );

  • trunk/wp-admin/includes/class-wp-filesystem-base.php

    r8600 r8645  
    11<?php
    2 class WP_Filesystem_Base{
     2/**
     3 * Base WordPress Filesystem.
     4 *
     5 * @package WordPress
     6 * @subpackage Filesystem
     7 */
     8
     9/**
     10 * Base WordPress Filesystem class for which Filesystem implementations extend
     11 *
     12 * @since 2.5
     13 */
     14class WP_Filesystem_Base {
    315    var $verbose = false;
    416    var $cache = array();
    … …  
    156168    }
    157169}
     170
    158171?>

  • trunk/wp-admin/includes/class-wp-filesystem-direct.php

    r8018 r8645  
    11<?php
    2 
     2/**
     3 * WordPress Direct Filesystem.
     4 *
     5 * @package WordPress
     6 * @subpackage Filesystem
     7 */
     8
     9/**
     10 * WordPress Filesystem Class for direct PHP file and folder manipulation.
     11 *
     12 * @since 2.5
     13 * @package WordPress
     14 * @subpackage Filesystem
     15 * @uses WP_Filesystem_Base Extends class
     16 */
    317class WP_Filesystem_Direct  extends WP_Filesystem_Base {
    418    var $permission = null;

  • trunk/wp-admin/includes/class-wp-filesystem-ftpext.php

    r8600 r8645  
    11<?php
    2 class WP_Filesystem_FTPext extends WP_Filesystem_Base{
     2/**
     3 * WordPress FTP Filesystem.
     4 *
     5 * @package WordPress
     6 * @subpackage Filesystem
     7 */
     8
     9/**
     10 * WordPress Filesystem Class for implementing FTP.
     11 *
     12 * @since 2.5
     13 * @package WordPress
     14 * @subpackage Filesystem
     15 * @uses WP_Filesystem_Base Extends class
     16 */
     17class WP_Filesystem_FTPext extends WP_Filesystem_Base {
    318    var $link;
    419    var $timeout = 5;

  • trunk/wp-admin/includes/class-wp-filesystem-ftpsockets.php

    r8600 r8645  
    11<?php
     2/**
     3 * WordPress FTP Sockets Filesystem.
     4 *
     5 * @package WordPress
     6 * @subpackage Filesystem
     7 */
     8
     9/**
     10 * WordPress Filesystem Class for implementing FTP Sockets.
     11 *
     12 * @since 2.5
     13 * @package WordPress
     14 * @subpackage Filesystem
     15 * @uses WP_Filesystem_Base Extends class
     16 */
    217class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
    318    var $ftp = false;
    … …  
    2338                            );
    2439
    25     function WP_Filesystem_ftpsockets($opt='') {
     40    function WP_Filesystem_ftpsockets($opt = '') {
    2641        $this->method = 'ftpsockets';
    2742        $this->errors = new WP_Error();
    … …  
    87102    }
    88103
    89     function get_contents($file, $type = '', $resumepos = 0){
     104    function get_contents($file, $type = '', $resumepos = 0) {
    90105        if( ! $this->exists($file) )
    91106            return false;
    … …  
    113128    }
    114129
    115     function get_contents_array($file){
     130    function get_contents_array($file) {
    116131        return explode("\n", $this->get_contents($file) );
    117132    }
    … …  
    152167    }
    153168
    154     function chmod($file, $mode = false, $recursive = false ){
     169    function chmod($file, $mode = false, $recursive = false ) {
    155170        if( ! $mode )
    156171            $mode = $this->permission;
    … …  
    252267    }
    253268
    254     function touch($file, $time = 0, $atime = 0 ){
     269    function touch($file, $time = 0, $atime = 0 ) {
    255270        return false;
    256271    }
    … …  
    312327    }
    313328
    314     function __destruct(){
     329    function __destruct() {
    315330        $this->ftp->quit();
    316331    }
    317332}
     333
    318334?>

  • trunk/wp-admin/includes/comment.php

    r7775 r8645  
    11<?php
    22
     3/**
     4 * {@internal Missing Short Description}}
     5 *
     6 * @since unknown
     7 * @uses $wpdb
     8 *
     9 * @param string $comment_author
     10 * @param string $comment_date
     11 * @return mixed Comment ID on success.
     12 */
    313function comment_exists($comment_author, $comment_date) {
    414    global $wpdb;
    … …  
    818}
    919
     20/**
     21 *
     22 *
     23 */
    1024function edit_comment() {
    1125

  • trunk/wp-admin/includes/update-core.php

    r8600 r8645  
    11<?php
    2 
     2/**
     3 * WordPress core upgrade functionality.
     4 *
     5 * @package WordPress
     6 * @subpackage Administration
     7 * @since 2.7
     8 */
     9
     10/**
     11 * Stores files to be deleted.
     12 *
     13 * @since 2.7
     14 * @global array $_old_files
     15 * @var array
     16 * @name $_old_files
     17 */
    318global $_old_files;
    419
    … …  
    118133);
    119134
     135/**
     136 * Upgrade the core of WordPress.
     137 *
     138 * This will create a .maintenance file at the base of the WordPress directory
     139 * to ensure that people can not access the web site, when the files are being
     140 * copied to their locations.
     141 *
     142 * The files in the {@link $_old_files} list will be removed and the new files
     143 * copied from the zip file after the database is upgraded.
     144 *
     145 * The steps for the upgrader for after the new release is downloaded and
     146 * unzipped is:
     147 *   1. Test unzipped location for select files to ensure that unzipped worked.
     148 *   2. Create the .maintenance file in current WordPress base.
     149 *   3. Copy new WordPress directory over old WordPress files.
     150 *   4. Upgrade WordPress to new version.
     151 *   5. Delete new WordPress directory path.
     152 *   6. Delete .maintenance file.
     153 *   7. Remove old files.
     154 *   8. Delete 'update_core' option.
     155 *
     156 * There are several areas of failure. For instance if PHP times out before step
     157 * 6, then you will not be able to access any portion of your site. Also, since
     158 * the upgrade will not continue where it left off, you will not be able to
     159 * automatically remove old files and remove the 'update_core' option. This
     160 * isn't that bad.
     161 *
     162 * If the copy of the new WordPress over the old fails, then the worse is that
     163 * the new WordPress directory will remain.
     164 *
     165 * If it is assumed that every file will be copied over, including plugins and
     166 * themes, then if you edit the default theme, you should rename it, so that
     167 * your changes remain.
     168 *
     169 * @param string $from New release unzipped path.
     170 * @param string $to Path to old WordPress installation.
     171 * @return WP_Error|null WP_Error on failure, null on success.
     172 */
    120173function update_core($from, $to) {
    121174    global $wp_filesystem, $_old_files;

  • trunk/wp-admin/install-helper.php

    r8610 r8645  
    11<?php
     2/**
     3 * Plugins may load this file to gain access to special helper functions for
     4 * plugin installation. This file is not included by WordPress and it is
     5 * recommended, to prevent fatal errors, that this file is included using
     6 * require_once().
     7 *
     8 * These functions are not optimized for speed, but they should only be used
     9 * once in a while, so speed shouldn't be a concern. If it is and you are
     10 * needing to use these functions a lot, you might experience time outs. If you
     11 * do, then it is advised to just write the SQL code yourself.
     12 *
     13 * You can turn debugging on, by setting $debug to 1 after you include this
     14 * file.
     15 *
     16 * <code>
     17 * check_column('wp_links', 'link_description', 'mediumtext');
     18 * if (check_column($wpdb->comments, 'comment_author', 'tinytext'))
     19 *     echo "ok\n";
     20 *
     21 * $error_count = 0;
     22 * $tablename = $wpdb->links;
     23 * // check the column
     24 * if (!check_column($wpdb->links, 'link_description', 'varchar(255)')) {
     25 *     $ddl = "ALTER TABLE $wpdb->links MODIFY COLUMN link_description varchar(255) NOT NULL DEFAULT '' ";
     26 *     $q = $wpdb->query($ddl);
     27 * }
     28 *
     29 * if (check_column($wpdb->links, 'link_description', 'varchar(255)')) {
     30 *     $res .= $tablename . ' - ok <br />';
     31 * } else {
     32 *     $res .= 'There was a problem with ' . $tablename . '<br />';
     33 *     ++$error_count;
     34 * }
     35 * </code>
     36 *
     37 * @package WordPress
     38 * @subpackage Plugins
     39 */
     40
     41/**
     42 * @global bool $wp_only_load_config
     43 * @name $wp_only_load_config
     44 * @var bool
     45 * @since unknown
     46 */
    247$wp_only_load_config = true;
     48
     49/** Load WordPress Bootstrap */
    350require_once(dirname(dirname(__FILE__)).'/wp-load.php');
     51
     52/**
     53 * Turn debugging on or off.
     54 * @global bool|int $debug
     55 * @name $debug
     56 * @var bool|int
     57 * @since unknown
     58 */
    459$debug = 0;
    560
    6 /**
    7  ** maybe_create_table()
    8  ** Create db table if it doesn't exist.
    9  ** Returns:  true if already exists or on successful completion
    10  **           false on error
    11  */
    1261if ( ! function_exists('maybe_create_table') ) :
     62/**
     63 * Create database table, if it doesn't already exist.
     64 *
     65 * @since unknown
     66 * @package WordPress
     67 * @subpackage Plugins
     68 * @uses $wpdb
     69 *
     70 * @param string $table_name Database table name.
     71 * @param string $create_ddl Create database table SQL.
     72 * @return bool False on error, true if already exists or success.
     73 */
    1374function maybe_create_table($table_name, $create_ddl) {
    1475    global $wpdb;
    … …  
    3091endif;
    3192
    32 /**
    33  ** maybe_add_column()
    34  ** Add column to db table if it doesn't exist.
    35  ** Returns:  true if already exists or on successful completion
    36  **           false on error
    37  */
    3893if ( ! function_exists('maybe_add_column') ) :
     94/**
     95 * Add column to database table, if column doesn't already exist in table.
     96 *
     97 * @since unknown
     98 * @package WordPress
     99 * @subpackage Plugins
     100 * @uses $wpdb
     101 * @uses $debug
     102 *
     103 * @param string $table_name Database table name
     104 * @param string $column_name Table column name
     105 * @param string $create_ddl SQL to add column to table.
     106 * @return bool False on failure. True, if already exists or was successful.
     107 */
    39108function maybe_add_column($table_name, $column_name, $create_ddl) {
    40109    global $wpdb, $debug;
    41110    foreach ($wpdb->get_col("DESC $table_name",0) as $column ) {
    42111        if ($debug) echo("checking $column == $column_name<br />");
    43             if ($column == $column_name) {
    44                 return true;
    45             }
     112
     113        if ($column == $column_name) {
     114            return true;
     115        }
    46116    }
    47117    //didn't find it try to create it.
    … …  
    58128
    59129/**
    60  ** maybe_drop_column()
    61  ** Drop column from db table if it exists.
    62  ** Returns:  true if it doesn't already exist or on successful drop
    63  **           false on error
     130 * Drop column from database table, if it exists.
     131 *
     132 * @since unknown
     133 * @package WordPress
     134 * @subpackage Plugins
     135 * @uses $wpdb
     136 *
     137 * @param string $table_name Table name
     138 * @param string $column_name Column name
     139 * @param string $drop_ddl SQL statement to drop column.
     140 * @return bool False on failure, true on success or doesn't exist.
    64141 */
    65142function maybe_drop_column($table_name, $column_name, $drop_ddl) {
    … …  
    81158}
    82159
    83 
    84 /**
    85  ** check_column()
    86  ** Check column matches passed in criteria.
    87  ** Pass in null to skip checking that criteria
    88  ** Returns:  true if it matches
    89  **           false otherwise
    90  ** (case sensitive) Column names returned from DESC table are:
    91  **      Field
    92  **      Type
    93  **      Null
    94  **      Key
    95  **      Default
    96  **      Extra
     160/**
     161 * Check column matches criteria.
     162 *
     163 * Uses the SQL DESC for retrieving the table info for the column. It will help
     164 * understand the parameters, if you do more research on what column information
     165 * is returned by the SQL statement. Pass in null to skip checking that
     166 * criteria.
     167 *
     168 * Column names returned from DESC table are case sensitive and are listed:
     169 *      Field
     170 *      Type
     171 *      Null
     172 *      Key
     173 *      Default
     174 *      Extra
     175 *
     176 * @param string $table_name Table name
     177 * @param string $col_name Column name
     178 * @param string $col_type Column type
     179 * @param bool $is_null Optional. Check is null.
     180 * @param mixed $key Optional. Key info.
     181 * @param mixed $default Optional. Default value.
     182 * @param mixed $extra Optional. Extra value.
     183 * @return bool True, if matches. False, if not matching.
    97184 */
    98185function check_column($table_name, $col_name, $col_type, $is_null = null, $key = null, $default = null, $extra = null) {
    … …  
    103190    foreach ($results as $row ) {
    104191        if ($debug > 1) print_r($row);
    105             if ($row->Field == $col_name) {
    106                 // got our column, check the params
    107                 if ($debug) echo ("checking $row->Type against $col_type\n");
    108                 if (($col_type != null) && ($row->Type != $col_type)) {
    109                     ++$diffs;
    110                 }
    111                 if (($is_null != null) && ($row->Null != $is_null)) {
    112                     ++$diffs;
    113                 }
    114                 if (($key != null) && ($row->Key  != $key)) {
    115                     ++$diffs;
    116                 }
    117                 if (($default != null) && ($row->Default != $default)) {
    118                     ++$diffs;
    119                 }
    120                 if (($extra != null) && ($row->Extra != $extra)) {
    121                     ++$diffs;
    122                 }
    123                 if ($diffs > 0) {
    124                     if ($debug) echo ("diffs = $diffs returning false\n");
    125                     return false;
    126                 }
    127                 return true;
    128             } // end if found our column
     192
     193        if ($row->Field == $col_name) {
     194            // got our column, check the params
     195            if ($debug) echo ("checking $row->Type against $col_type\n");
     196            if (($col_type != null) && ($row->Type != $col_type)) {
     197                ++$diffs;
     198            }
     199            if (($is_null != null) && ($row->Null != $is_null)) {
     200                ++$diffs;
     201            }
     202            if (($key != null) && ($row->Key  != $key)) {
     203                ++$diffs;
     204            }
     205            if (($default != null) && ($row->Default != $default)) {
     206                ++$diffs;
     207            }
     208            if (($extra != null) && ($row->Extra != $extra)) {
     209                ++$diffs;
     210            }
     211            if ($diffs > 0) {
     212                if ($debug) echo ("diffs = $diffs returning false\n");
     213                return false;
     214            }
     215            return true;
     216        } // end if found our column
    129217    }
    130218    return false;
    131219}
    132220
    133 /*
    134 echo "<p>testing</p>";
    135 echo "<pre>";
    136 
    137 //check_column('wp_links', 'link_description', 'mediumtext');
    138 //if (check_column($wpdb->comments, 'comment_author', 'tinytext'))
    139 //    echo "ok\n";
    140 $error_count = 0;
    141 $tablename = $wpdb->links;
    142 // check the column
    143 if (!check_column($wpdb->links, 'link_description', 'varchar(255)'))
    144 {
    145     $ddl = "ALTER TABLE $wpdb->links MODIFY COLUMN link_description varchar(255) NOT NULL DEFAULT '' ";
    146     $q = $wpdb->query($ddl);
    147 }
    148 if (check_column($wpdb->links, 'link_description', 'varchar(255)')) {
    149     $res .= $tablename . ' - ok <br />';
    150 } else {
    151     $res .= 'There was a problem with ' . $tablename . '<br />';
    152     ++$error_count;
    153 }
    154 echo "</pre>";
    155 */
    156221?>

  • trunk/wp-admin/install.php

    r8309 r8645  
    11<?php
     2/**
     3 * WordPress Installer
     4 *
     5 * @package WordPress
     6 * @subpackage Administration
     7 */
     8
     9/**
     10 * We are installing WordPress.
     11 *
     12 * @since unknown
     13 * @var bool
     14 */
    215define('WP_INSTALLING', true);
    316
     17/** Load WordPress Bootstrap */
    418require_once('../wp-load.php');
     19
     20/** Load WordPress Administration Upgrade API */
    521require_once('./includes/upgrade.php');
    622
    … …  
    925else
    1026    $step = 0;
    11 function display_header(){
     27
     28/**
     29 * Display install header.
     30 *
     31 * @since unknown
     32 * @package WordPress
     33 * @subpackage Installer
     34 */
     35function display_header() {
    1236header( 'Content-Type: text/html; charset=utf-8' );
    1337?>

  • trunk/wp-admin/link-add.php

    r8589 r8645  
    11<?php
     2/**
     3 * Add Link Administration Panel.
     4 *
     5 * @package WordPress
     6 * @subpackage Administration
     7 */
     8
     9/** Load WordPress Administration Bootstrap */
    210require_once('admin.php');
    311

  • trunk/wp-admin/link-category.php

    r8391 r8645  
    11<?php
     2/**
     3 * Manage link category administration actions.
     4 *
     5 * This page is accessed by the link management pages and handles the forms and
     6 * AJAX processes for category actions.
     7 *
     8 * @package WordPress
     9 * @subpackage Administration
     10 */
     11
     12/** Load WordPress Administration Bootstrap */
    213require_once('admin.php');
    314
    … …  
    3243
    3344    // Don't delete the default cats.
    34     if ( $cat_ID == $default_cat_id )
     45    if ( $cat_ID == $default_cat_id )
    3546        wp_die(sprintf(__("Can&#8217;t delete the <strong>%s</strong> category: this is the default one"), $cat_name));
    3647

  • trunk/wp-admin/link-import.php

    r7883 r8645  
    11<?php
    2 // Links
    3 // Copyright (C) 2002 Mike Little -- mike@zed1.com
     2/**
     3 * Links Import Administration Panel.
     4 *
     5 * @copyright 2002 Mike Little <mike@zed1.com>
     6 * @author Mike Little <mike@zed1.com>
     7 * @package WordPress
     8 * @subpackage Administration
     9 */
    410
     11/** Load WordPress Administration Bootstrap */
    512require_once('admin.php');
    613$parent_file = 'edit.php';
    … …  
    99106            }
    100107
     108            /** Load OPML Parser */
    101109            include_once('link-parse-opml.php');
    102110

  • trunk/wp-admin/link-manager.php

    r8589 r8645  
    11<?php
    2 
     2/**
     3 * Link Management Administration Panel.
     4 *
     5 * @package WordPress
     6 * @subpackage Administration
     7 */
     8
     9/** Load WordPress Administration Bootstrap */
    310require_once ('admin.php');
    411

  • trunk/wp-admin/link-parse-opml.php

    r7971 r8645  
    11<?php
     2/**
     3 * Parse OPML XML files and store in globals.
     4 *
     5 * @package WordPress
     6 * @subpackage Administration
     7 */
     8
     9/** Load WordPress Bootstrap */
    210require_once('../wp-load.php');
    311
    … …  
    1624
    1725/**
    18  ** startElement()
    19  ** Callback function. Called at the start of a new xml tag.
    20  **/
     26 * XML callback function for the start of a new XML tag.
     27 *
     28 * @since unknown
     29 * @access private
     30 *
     31 * @uses $updated_timestamp Not used inside function.
     32 * @uses $all_links Not used inside function.
     33 * @uses $map Stores names of attributes to use.
     34 * @global array $names
     35 * @global array $urls
     36 * @global array $targets
     37 * @global array $descriptions
     38 * @global array $feeds
     39 *
     40 * @param mixed $parser XML Parser resource.
     41 * @param string $tagName XML element name.
     42 * @param array $attrs XML element attributes.
     43 */
    2144function startElement($parser, $tagName, $attrs) {
    2245    global $updated_timestamp, $all_links, $map;
    … …  
    4265
    4366/**
    44  ** endElement()
    45  ** Callback function. Called at the end of an xml tag.
    46  **/
     67 * XML callback function that is called at the end of a XML tag.
     68 *
     69 * @since unknown
     70 * @access private
     71 * @package WordPress
     72 * @subpackage Dummy
     73 *
     74 * @param mixed $parser XML Parser resource.
     75 * @param string $tagName XML tag name.
     76 */
    4777function endElement($parser, $tagName) {
    4878    // nothing to do.

  • trunk/wp-admin/link.php

    r7961 r8645  
    11<?php
     2/**
     3 * Manage link administration actions.
     4 *
     5 * This page is accessed by the link management pages and handles the forms and
     6 * AJAX processes for link actions.
     7 *
     8 * @package WordPress
     9 * @subpackage Administration
     10 */
     11
     12/** Load WordPress Administration Bootstrap */
    213require_once ('admin.php');
    314

  • trunk/wp-admin/media-upload.php

    r7213 r8645  
    11<?php
     2/**
     3 * Manage media uploaded file.
     4 *
     5 * There are many filters in here for media. Plugins can extend functionality
     6 * by hooking into the filters.
     7 *
     8 * @package WordPress
     9 * @subpackage Administration
     10 */
     11
     12/** Load WordPress Administration Bootstrap */
    213require_once('admin.php');
    314wp_enqueue_script('swfupload');
    … …  
    1223
    1324// IDs should be integers
    14 $ID = isset($ID)? (int) $ID : 0;
     25$ID = isset($ID) ? (int) $ID : 0;
    1526$post_id = isset($post_id)? (int) $post_id : 0;
    1627

  • trunk/wp-admin/media.php

    r7979 r8645  
    11<?php
     2/**
     3 * Media management action handler.
     4 *
     5 * @package WordPress
     6 * @subpackage Administration
     7 */
    28
     9/** Load WordPress Administration Bootstrap */
    310require_once('admin.php');
    411

  • trunk/wp-admin/menu-header.php

    r8049 r8645  
    11<?php
     2/**
     3 * Displays Administration Menu.
     4 *
     5 * @package WordPress
     6 * @subpackage Administration
     7 */
     8
     9/**
     10 * The current page.
     11 *
     12 * @global string $self
     13 * @name $self
     14 * @var string
     15 */
    216$self = preg_replace('|^.*/wp-admin/|i', '', $_SERVER['PHP_SELF']);
    317$self = preg_replace('|^.*/plugins/|i', '', $self);

  • trunk/wp-admin/menu.php

    r8589 r8645  
    11<?php
    2 // This array constructs the admin menu bar.
    3 //
    4 // Menu item name
    5 // The minimum level the user needs to access the item: between 0 and 10
    6 // The URL of the item's file
     2/**
     3 * Build Administration Menu.
     4 *
     5 * @package WordPress
     6 * @subpackage Administration
     7 */
     8
     9/**
     10 * Constructs the admin menu bar.
     11 *
     12 * The elements in the array are :
     13 *     0: Menu item name
     14 *     1: Minimum level or capability required.
     15 *     2: The URL of the item's file
     16 *
     17 * @global array $menu
     18 * @name $menu
     19 * @var array
     20 */
    721$menu[0] = array(__('Dashboard'), 'read', 'index.php');
    822

  • trunk/wp-admin/moderation.php

    r7971 r8645  
    11<?php
     2/**
     3 * Comment Moderation Administration Panel.
     4 *
     5 * Redirects to edit-comments.php?comment_status=moderated.
     6 *
     7 * @package WordPress
     8 * @subpackage Administration
     9 */
    210require_once('../wp-load.php');
    311wp_redirect('edit-comments.php?comment_status=moderated');

  • trunk/wp-admin/options-head.php

    r6833 r8645  
    1 <?php wp_reset_vars(array('action', 'standalone', 'option_group_id')); ?>
     1<?php
     2/**
     3 * WordPress Options Header.
     4 *
     5 * Resets variables: 'action', 'standalone', and 'option_group_id'. Displays
     6 * updated message, if updated variable is part of the URL query.
     7 *
     8 * @package WordPress
     9 * @subpackage Administration
     10 */
     11
     12wp_reset_vars(array('action', 'standalone', 'option_group_id'));
     13?>
    214
    315<?php if (isset($_GET['updated'])) : ?>

  • trunk/wp-admin/options-privacy.php

    r7883 r8645  
    11<?php
     2/**
     3 * Privacy Options Settings Administration Panel.
     4 *
     5 * @package WordPress
     6 * @subpackage Administration
     7 */
     8
     9/** Load WordPress Administration Bootstrap */
    210require_once('./admin.php');
    311

  • trunk/wp-admin/post-new.php

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

  • trunk/wp-admin/profile.php

    r6700 r8645  
    11<?php
     2/**
     3 * User Profile Administration Panel.
     4 *
     5 * @package WordPress
     6 * @subpackage Administration
     7 */
     8
     9/**
     10 * This is a profile page.
     11 *
     12 * @since unknown
     13 * @var bool
     14 */
    215define('IS_PROFILE_PAGE', true);
     16
     17/** Load User Editing Page */
    318require_once('user-edit.php');
    419?>

  • trunk/wp-admin/setup-config.php

    r8309 r8645  
    11<?php
     2/**
     3 * Retrieves and creates the wp-config.php file.
     4 *
     5 * The permissions for the base directory must allow for writing files in order
     6 * for the wp-config.php to be created using this page.
     7 *
     8 * @package WordPress
     9 * @subpackage Administration
     10 */
     11
     12/**
     13 * We are installing.
     14 *
     15 * @since unknown
     16 * @package WordPress
     17 */
    218define('WP_INSTALLING', true);
    319//These three defines are required to allow us to use require_wp_db() to load the database class while being wp-content/wp-db.php aware
    … …  
    3147    $step = 0;
    3248
    33 function display_header(){
     49/**
     50 * Display setup wp-config.php file header.
     51 *
     52 * @since unknown
     53 * @package WordPress
     54 * @subpackage Installer_WP_Config
     55 */
     56function display_header() {
    3457    header( 'Content-Type: text/html; charset=utf-8' );
    3558?>

  • trunk/wp-admin/update-links.php

    r7971 r8645  
    11<?php
     2/**
     3 * Send blog links to pingomatic.com to update.
     4 *
     5 * You can disable this feature by deleting the option 'use_linksupdate' or
     6 * setting the option to false. If no links exist, then no links are sent.
     7 *
     8 * Snoopy is included, but is not used. Fsockopen() is used instead to send link
     9 * URLs.
     10 *
     11 * @package WordPress
     12 * @subpackage Administration
     13 */
     14
     15/** Load WordPress Bootstrap */
    216require_once('../wp-load.php');
     17
     18/** Load Snoopy HTTP Client class */
    319require_once( ABSPATH . 'wp-includes/class-snoopy.php');
    420

  • trunk/wp-admin/upgrade-functions.php

    r7448 r8645  
    11<?php
    2 // Deprecated.  Use includes/upgrade.php.
     2/**
     3 * WordPress Upgrade Functions. Old file, must not be used. Include
     4 * wp-admin/includes/upgrade.php instead.
     5 *
     6 * @deprecated 2.5
     7 * @package WordPress
     8 * @subpackage Administration
     9 */
     10
    311_deprecated_file( basename(__FILE__), '2.5', 'wp-admin/includes/upgrade.php' );
    412require_once(ABSPATH . 'wp-admin/includes/upgrade.php');

  • trunk/wp-admin/upgrade.php

    r8297 r8645  
    11<?php
     2/**
     3 * Upgrade WordPress Page.
     4 *
     5 * @package WordPress
     6 * @subpackage Administration
     7 */
     8
     9/**
     10 * We are upgrading WordPress.
     11 *
     12 * @since unknown
     13 * @var bool
     14 */
    215define('WP_INSTALLING', true);
    316
     17/** Load WordPress Bootstrap */
    418require('../wp-load.php');
     19
    520timer_start();
    621require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
Note: See TracChangeset for help on using the changeset viewer.