WordPress.org

Make WordPress Core

Ticket #17414: 17414.package-and-subpackage-tags.diff

File 17414.package-and-subpackage-tags.diff, 51.3 KB (added by mfields, 4 years ago)

Removes @package and @subpackage from many function doc blocks. Adds these tags in a few places.

  • wp-includes/post-template.php

     
    579579 
    580580/** 
    581581 * Page Template Functions for usage in Themes 
    582  * 
    583  * @package WordPress 
    584  * @subpackage Template 
    585582 */ 
    586583 
    587584/** 
     
    12551252/** 
    12561253 * Retrieve formatted date timestamp of a revision (linked to that revisions's page). 
    12571254 * 
    1258  * @package WordPress 
    1259  * @subpackage Post_Revisions 
    12601255 * @since 2.6.0 
    12611256 * 
    12621257 * @uses date_i18n() 
     
    13061301 *   (int)    left   : what revision is currently being diffed against right - 
    13071302 *                     used in form-table format. 
    13081303 * 
    1309  * @package WordPress 
    1310  * @subpackage Post_Revisions 
    13111304 * @since 2.6.0 
    13121305 * 
    13131306 * @uses wp_get_post_revisions() 
  • wp-includes/plugin.php

     
    4949 * is even a string. It is up to you to take care and this is done for 
    5050 * optimization purposes, so everything is as quick as possible. 
    5151 * 
    52  * @package WordPress 
    53  * @subpackage Plugin 
    5452 * @since 0.71 
    5553 * @global array $wp_filter Stores all of the filters added in the form of 
    5654 *      wp_filter['tag']['array of priorities']['array of functions serialized']['array of ['array (functions, accepted_args)']'] 
     
    7472/** 
    7573 * Check if any filter has been registered for a hook. 
    7674 * 
    77  * @package WordPress 
    78  * @subpackage Plugin 
    7975 * @since 2.5 
    8076 * @global array $wp_filter Stores all of the filters 
    8177 * 
     
    119115 * $value = apply_filters('example_filter', 'filter me', 'arg1', 'arg2'); 
    120116 * </code> 
    121117 * 
    122  * @package WordPress 
    123  * @subpackage Plugin 
    124118 * @since 0.71 
    125119 * @global array $wp_filter Stores all of the filters 
    126120 * @global array $merged_filters Merges the filter hooks using this function. 
     
    183177 * @see apply_filters() This function is identical, but the arguments passed to the 
    184178 * functions hooked to <tt>$tag</tt> are supplied using an array. 
    185179 * 
    186  * @package WordPress 
    187  * @subpackage Plugin 
    188180 * @since 3.0.0 
    189181 * @global array $wp_filter Stores all of the filters 
    190182 * @global array $merged_filters Merges the filter hooks using this function. 
     
    244236 * when the hook was added. This goes for both filters and actions. No warning 
    245237 * will be given on removal failure. 
    246238 * 
    247  * @package WordPress 
    248  * @subpackage Plugin 
    249239 * @since 1.2 
    250240 * 
    251241 * @param string $tag The filter hook to which the function to be removed is hooked. 
     
    297287/** 
    298288 * Retrieve the name of the current filter or action. 
    299289 * 
    300  * @package WordPress 
    301  * @subpackage Plugin 
    302290 * @since 2.5 
    303291 * 
    304292 * @return string Hook name of the current filter or action. 
     
    319307 * 
    320308 * @uses add_filter() Adds an action. Parameter list and functionality are the same. 
    321309 * 
    322  * @package WordPress 
    323  * @subpackage Plugin 
    324310 * @since 1.2 
    325311 * 
    326312 * @param string $tag The name of the action to which the $function_to_add is hooked. 
     
    346332 * @see apply_filters() This function works similar with the exception that 
    347333 * nothing is returned and only the functions or methods are called. 
    348334 * 
    349  * @package WordPress 
    350  * @subpackage Plugin 
    351335 * @since 1.2 
    352336 * @global array $wp_filter Stores all of the filters 
    353337 * @global array $wp_actions Increments the amount of times action was triggered. 
     
    412396/** 
    413397 * Retrieve the number times an action is fired. 
    414398 * 
    415  * @package WordPress 
    416  * @subpackage Plugin 
    417399 * @since 2.1 
    418400 * @global array $wp_actions Increments the amount of times action was triggered. 
    419401 * 
     
    435417 * @see do_action() This function is identical, but the arguments passed to the 
    436418 * functions hooked to <tt>$tag</tt> are supplied using an array. 
    437419 * 
    438  * @package WordPress 
    439  * @subpackage Plugin 
    440420 * @since 2.1 
    441421 * @global array $wp_filter Stores all of the filters 
    442422 * @global array $wp_actions Increments the amount of times action was triggered. 
     
    493473/** 
    494474 * Check if any action has been registered for a hook. 
    495475 * 
    496  * @package WordPress 
    497  * @subpackage Plugin 
    498476 * @since 2.5 
    499477 * @see has_filter() has_action() is an alias of has_filter(). 
    500478 * 
     
    513491 * method can be used to remove default functions attached to a specific filter 
    514492 * hook and possibly replace them with a substitute. 
    515493 * 
    516  * @package WordPress 
    517  * @subpackage Plugin 
    518494 * @since 1.2 
    519495 * 
    520496 * @param string $tag The action hook to which the function to be removed is hooked. 
     
    549525 * 
    550526 * This method extracts the name of a plugin from its filename. 
    551527 * 
    552  * @package WordPress 
    553  * @subpackage Plugin 
    554528 * @since 1.5 
    555529 * 
    556530 * @access private 
     
    573547 
    574548/** 
    575549 * Gets the filesystem directory path (with trailing slash) for the plugin __FILE__ passed in 
    576  * @package WordPress 
    577  * @subpackage Plugin 
     550 * 
    578551 * @since 2.8 
    579552 * 
    580553 * @param string $file The filename of the plugin (__FILE__) 
     
    586559 
    587560/** 
    588561 * Gets the URL directory path (with trailing slash) for the plugin __FILE__ passed in 
    589  * @package WordPress 
    590  * @subpackage Plugin 
     562 * 
    591563 * @since 2.8 
    592564 * 
    593565 * @param string $file The filename of the plugin (__FILE__) 
     
    609581 * wp-content/plugin/sample.php the name of this hook will be 
    610582 * 'activate_sample.php'. 
    611583 * 
    612  * @package WordPress 
    613  * @subpackage Plugin 
    614584 * @since 2.0 
    615585 * 
    616586 * @param string $file The filename of the plugin including the path. 
     
    634604 * wp-content/plugin/sample.php the name of this hook will be 
    635605 * 'activate_sample.php'. 
    636606 * 
    637  * @package WordPress 
    638  * @subpackage Plugin 
    639607 * @since 2.0 
    640608 * 
    641609 * @param string $file The filename of the plugin including the path. 
     
    696664 * functions. This function does not check for the existence of the all hook, so 
    697665 * it will fail unless the all hook exists prior to this function call. 
    698666 * 
    699  * @package WordPress 
    700  * @subpackage Plugin 
    701667 * @since 2.5 
    702668 * @access private 
    703669 * 
     
    735701 * Functions and static method callbacks are just returned as strings and 
    736702 * shouldn't have any speed penalty. 
    737703 * 
    738  * @package WordPress 
    739  * @subpackage Plugin 
    740704 * @access private 
    741705 * @since 2.2.3 
    742706 * @link http://trac.wordpress.org/ticket/3875 
  • wp-includes/taxonomy.php

     
    104104/** 
    105105 * Get a list of registered taxonomy objects. 
    106106 * 
    107  * @package WordPress 
    108  * @subpackage Taxonomy 
    109107 * @since 3.0.0 
    110108 * @uses $wp_taxonomies 
    111109 * @see register_taxonomy 
     
    134132 * <code><?php $taxonomies = get_object_taxonomies('post'); ?></code> Should 
    135133 * result in <code>Array('category', 'post_tag')</code> 
    136134 * 
    137  * @package WordPress 
    138  * @subpackage Taxonomy 
    139135 * @since 2.3.0 
    140136 * 
    141137 * @uses $wp_taxonomies 
     
    174170 * The get_taxonomy function will first check that the parameter string given 
    175171 * is a taxonomy object and if it is, it will return it. 
    176172 * 
    177  * @package WordPress 
    178  * @subpackage Taxonomy 
    179173 * @since 2.3.0 
    180174 * 
    181175 * @uses $wp_taxonomies 
     
    198192 * 
    199193 * Formerly is_taxonomy(), introduced in 2.3.0. 
    200194 * 
    201  * @package WordPress 
    202  * @subpackage Taxonomy 
    203195 * @since 3.0.0 
    204196 * 
    205197 * @uses $wp_taxonomies 
     
    221213 * 
    222214 * A false return value might also mean that the taxonomy does not exist. 
    223215 * 
    224  * @package WordPress 
    225  * @subpackage Taxonomy 
    226216 * @since 2.3.0 
    227217 * 
    228218 * @uses taxonomy_exists() Checks whether taxonomy exists 
     
    280270 * 
    281271 * labels - An array of labels for this taxonomy. You can see accepted values in {@link get_taxonomy_labels()}. By default tag labels are used for non-hierarchical types and category labels for hierarchical ones. 
    282272 * 
    283  * @package WordPress 
    284  * @subpackage Taxonomy 
    285273 * @since 2.3.0 
    286274 * @uses $wp_taxonomies Inserts new taxonomy object into the list 
    287275 * @uses $wp_rewrite Adds rewrite tags and permastructs 
     
    419407/** 
    420408 * Add an already registered taxonomy to an object type. 
    421409 * 
    422  * @package WordPress 
    423  * @subpackage Taxonomy 
    424410 * @since 3.0.0 
    425411 * @uses $wp_taxonomies Modifies taxonomy object 
    426412 * 
     
    462448 * using PHP sort family functions or using the database by using $args with 
    463449 * either ASC or DESC array. The value should be in the key named 'order'. 
    464450 * 
    465  * @package WordPress 
    466  * @subpackage Taxonomy 
    467451 * @since 2.3.0 
    468452 * 
    469453 * @uses $wpdb 
     
    528512/** 
    529513 * Container class for a multiple taxonomy query. 
    530514 * 
     515 * @package WordPress 
     516 * @subpackage Taxonomy 
    531517 * @since 3.1.0 
    532518 */ 
    533519class WP_Tax_Query { 
     
    814800 * example, if 'category', it would be 'get_category' as the filter name. Useful 
    815801 * for custom taxonomies or plugging into default taxonomies. 
    816802 * 
    817  * @package WordPress 
    818  * @subpackage Taxonomy 
    819803 * @since 2.3.0 
    820804 * 
    821805 * @uses $wpdb 
     
    887871 * If $value does not exist, the return value will be false. If $taxonomy exists 
    888872 * and $field and $value combinations exist, the Term will be returned. 
    889873 * 
    890  * @package WordPress 
    891  * @subpackage Taxonomy 
    892874 * @since 2.3.0 
    893875 * 
    894876 * @uses $wpdb 
     
    953935 * 
    954936 * Will return an empty array if $term does not exist in $taxonomy. 
    955937 * 
    956  * @package WordPress 
    957  * @subpackage Taxonomy 
    958938 * @since 2.3.0 
    959939 * 
    960940 * @uses $wpdb 
     
    993973 * reasons and for simplicity of usage. See sanitize_term_field() for more 
    994974 * information. 
    995975 * 
    996  * @package WordPress 
    997  * @subpackage Taxonomy 
    998976 * @since 2.3.0 
    999977 * 
    1000978 * @uses sanitize_term_field() Passes the return value in sanitize_term_field on success. 
     
    10261004 * Return value is sanitize_term() and usage is for sanitizing the term for 
    10271005 * editing. Function is for contextual and simplicity. 
    10281006 * 
    1029  * @package WordPress 
    1030  * @subpackage Taxonomy 
    10311007 * @since 2.3.0 
    10321008 * 
    10331009 * @uses sanitize_term() Passes the return value on success 
     
    11291105 * The 'parent' argument is different from 'child_of' in that a term X is considered a 'parent' 
    11301106 * of term Y only if term X is the father of term Y, not its grandfather or great-grandfather, etc. 
    11311107 * 
    1132  * @package WordPress 
    1133  * @subpackage Taxonomy 
    11341108 * @since 2.3.0 
    11351109 * 
    11361110 * @uses $wpdb 
     
    14201394 * 
    14211395 * Formerly is_term(), introduced in 2.3.0. 
    14221396 * 
    1423  * @package WordPress 
    1424  * @subpackage Taxonomy 
    14251397 * @since 3.0.0 
    14261398 * 
    14271399 * @uses $wpdb 
     
    14891461 * 
    14901462 * The $term is expected to be either an array or an object. 
    14911463 * 
    1492  * @package WordPress 
    1493  * @subpackage Taxonomy 
    14941464 * @since 2.3.0 
    14951465 * 
    14961466 * @uses sanitize_term_field Used to sanitize all fields in a term 
     
    15441514 * without creating your own filter function. Simply create a function that 
    15451515 * hooks into the filter you need. 
    15461516 * 
    1547  * @package WordPress 
    1548  * @subpackage Taxonomy 
    15491517 * @since 2.3.0 
    15501518 * 
    15511519 * @uses $wpdb 
     
    16031571 * 
    16041572 * Default $args is 'hide_empty' which can be 'hide_empty=true' or array('hide_empty' => true). 
    16051573 * 
    1606  * @package WordPress 
    1607  * @subpackage Taxonomy 
    16081574 * @since 2.3.0 
    16091575 * 
    16101576 * @uses get_terms() 
     
    16361602 * a particular taxonomy or taxonomies. Does not remove the term or 
    16371603 * taxonomy itself. 
    16381604 * 
    1639  * @package WordPress 
    1640  * @subpackage Taxonomy 
    16411605 * @since 2.3.0 
    16421606 * @uses $wpdb 
    16431607 * 
     
    16731637 * 
    16741638 * The $args 'force_default' will force the term supplied as default to be 
    16751639 * assigned even if the object was not going to be termless 
    1676  * @package WordPress 
    1677  * @subpackage Taxonomy 
     1640 * 
    16781641 * @since 2.3.0 
    16791642 * 
    16801643 * @uses $wpdb 
     
    18011764 * terms objects will be returned. If either 'ids' or 'names' is used, then an 
    18021765 * array of all matching term ids or term names will be returned respectively. 
    18031766 * 
    1804  * @package WordPress 
    1805  * @subpackage Taxonomy 
    18061767 * @since 2.3.0 
    18071768 * @uses $wpdb 
    18081769 * 
     
    19361897 * second check succeeds, the term will be inserted and the term id will be 
    19371898 * given. 
    19381899 * 
    1939  * @package WordPress 
    1940  * @subpackage Taxonomy 
    19411900 * @since 2.3.0 
    19421901 * @uses $wpdb 
    19431902 * 
     
    20702029 * A term has no meaning until it is given context by defining which taxonomy it 
    20712030 * exists under. 
    20722031 * 
    2073  * @package WordPress 
    2074  * @subpackage Taxonomy 
    20752032 * @since 2.3.0 
    20762033 * @uses $wpdb 
    20772034 * 
     
    21682125 * 
    21692126 * The only purpose for $term is for appending a parent, if one exists. 
    21702127 * 
    2171  * @package WordPress 
    2172  * @subpackage Taxonomy 
    21732128 * @since 2.3.0 
    21742129 * @uses $wpdb 
    21752130 * 
     
    22412196 * For what can be overrode in $args, check the term scheme can contain and stay 
    22422197 * away from the term keys. 
    22432198 * 
    2244  * @package WordPress 
    2245  * @subpackage Taxonomy 
    22462199 * @since 2.3.0 
    22472200 * 
    22482201 * @uses $wpdb 
     
    23762329 * The default action is to count what the amount of terms have the relationship 
    23772330 * of term ID. Once that is done, then update the database. 
    23782331 * 
    2379  * @package WordPress 
    2380  * @subpackage Taxonomy 
    23812332 * @since 2.3.0 
    23822333 * @uses $wpdb 
    23832334 * 
     
    24562407 * term IDs have to exist within the taxonomy $object_type for the deletion to 
    24572408 * take place. 
    24582409 * 
    2459  * @package WordPress 
    2460  * @subpackage Taxonomy 
    24612410 * @since 2.3.0 
    24622411 * 
    24632412 * @see get_object_taxonomies() for more on $object_type 
     
    24822431/** 
    24832432 * Will remove all of the term ids from the cache. 
    24842433 * 
    2485  * @package WordPress 
    2486  * @subpackage Taxonomy 
    24872434 * @since 2.3.0 
    24882435 * @uses $wpdb 
    24892436 * 
     
    25432490/** 
    25442491 * Retrieves the taxonomy relationship to the term object id. 
    25452492 * 
    2546  * @package WordPress 
    2547  * @subpackage Taxonomy 
    25482493 * @since 2.3.0 
    25492494 * 
    25502495 * @uses wp_cache_get() Retrieves taxonomy relationship from cache 
     
    25722517 * lot of terms that exist in a lot of taxonomies. The amount of time increases 
    25732518 * for each term and it also increases for each taxonomy the term belongs to. 
    25742519 * 
    2575  * @package WordPress 
    2576  * @subpackage Taxonomy 
    25772520 * @since 2.3.0 
    25782521 * @uses wp_get_object_terms() Used to get terms from the database to update 
    25792522 * 
     
    26322575/** 
    26332576 * Updates Terms to Taxonomy in cache. 
    26342577 * 
    2635  * @package WordPress 
    2636  * @subpackage Taxonomy 
    26372578 * @since 2.3.0 
    26382579 * 
    26392580 * @param array $terms List of Term objects to change 
     
    26572598/** 
    26582599 * Retrieves children of taxonomy as Term IDs. 
    26592600 * 
    2660  * @package WordPress 
    2661  * @subpackage Taxonomy 
    26622601 * @access private 
    26632602 * @since 2.3.0 
    26642603 * 
     
    26932632 * If $terms is an array of objects, then _get_term_children returns an array of objects. 
    26942633 * If $terms is an array of IDs, then _get_term_children returns an array of IDs. 
    26952634 * 
    2696  * @package WordPress 
    2697  * @subpackage Taxonomy 
    26982635 * @access private 
    26992636 * @since 2.3.0 
    27002637 * 
     
    27502687 * Recalculates term counts by including items from child terms. Assumes all 
    27512688 * relevant children are already in the $terms argument. 
    27522689 * 
    2753  * @package WordPress 
    2754  * @subpackage Taxonomy 
    27552690 * @access private 
    27562691 * @since 2.3.0 
    27572692 * @uses $wpdb 
     
    28162751 * Private function for the default callback for post_tag and category 
    28172752 * taxonomies. 
    28182753 * 
    2819  * @package WordPress 
    2820  * @subpackage Taxonomy 
    28212754 * @access private 
    28222755 * @since 2.3.0 
    28232756 * @uses $wpdb 
  • wp-includes/post.php

     
    633633 * 
    634634 * Arguments prefixed with an _underscore shouldn't be used by plugins and themes. 
    635635 * 
    636  * @package WordPress 
    637  * @subpackage Post 
    638636 * @since 3.0.0 
    639637 * @uses $wp_post_statuses Inserts new post status object into the list 
    640638 * 
     
    699697/** 
    700698 * Retrieve a post status object by name 
    701699 * 
    702  * @package WordPress 
    703  * @subpackage Post 
    704700 * @since 3.0.0 
    705701 * @uses $wp_post_statuses 
    706702 * @see register_post_status 
     
    721717/** 
    722718 * Get a list of all registered post status objects. 
    723719 * 
    724  * @package WordPress 
    725  * @subpackage Post 
    726720 * @since 3.0.0 
    727721 * @uses $wp_post_statuses 
    728722 * @see register_post_status 
     
    801795/** 
    802796 * Retrieve a post type object by name 
    803797 * 
    804  * @package WordPress 
    805  * @subpackage Post 
    806798 * @since 3.0.0 
    807799 * @uses $wp_post_types 
    808800 * @see register_post_type 
     
    823815/** 
    824816 * Get a list of all registered post type objects. 
    825817 * 
    826  * @package WordPress 
    827  * @subpackage Post 
    828818 * @since 2.9.0 
    829819 * @uses $wp_post_types 
    830820 * @see register_post_type 
     
    22352225 * is set to 'all'. There are other defaults that can be overridden in 
    22362226 * {@link wp_get_object_terms()}. 
    22372227 * 
    2238  * @package WordPress 
    2239  * @subpackage Post 
    22402228 * @since 2.3.0 
    22412229 * 
    22422230 * @uses wp_get_object_terms() Gets the tags for returning. Args can be found here 
     
    22562244 * is set to 'all'. There are other defaults that can be overridden in 
    22572245 * {@link wp_get_object_terms()}. 
    22582246 * 
    2259  * @package WordPress 
    2260  * @subpackage Post 
    22612247 * @since 2.8.0 
    22622248 * 
    22632249 * @uses wp_get_object_terms() Gets the tags for returning. Args can be found here 
     
    28422828 * 
    28432829 * @uses wp_set_post_tags() Same first two parameters, but the last parameter is always set to true. 
    28442830 * 
    2845  * @package WordPress 
    2846  * @subpackage Post 
    28472831 * @since 2.3.0 
    28482832 * 
    28492833 * @param int $post_id Post ID 
     
    42314215 * 
    42324216 * @usedby update_page_cache() Aliased by this function. 
    42334217 * 
    4234  * @package WordPress 
    4235  * @subpackage Cache 
    42364218 * @since 1.5.1 
    42374219 * 
    42384220 * @param array $posts Array of post objects 
     
    42564238 * This function not run if $_wp_suspend_cache_invalidation is not empty. See 
    42574239 * wp_suspend_cache_invalidation(). 
    42584240 * 
    4259  * @package WordPress 
    4260  * @subpackage Cache 
    42614241 * @since 2.0.0 
    42624242 * 
    42634243 * @uses do_action() Calls 'clean_post_cache' on $id before adding children (if any). 
     
    43024282 * 
    43034283 * @see update_post_cache() Posts and pages are the same, alias is intentional 
    43044284 * 
    4305  * @package WordPress 
    4306  * @subpackage Cache 
    43074285 * @since 1.5.1 
    43084286 * 
    43094287 * @param array $pages list of page objects 
     
    43184296 * Clean (read: delete) page from cache that matches $id. Will also clean cache 
    43194297 * associated with 'all_page_ids' and 'get_pages'. 
    43204298 * 
    4321  * @package WordPress 
    4322  * @subpackage Cache 
    43234299 * @since 2.0.0 
    43244300 * 
    43254301 * @uses do_action() Will call the 'clean_page_cache' hook action. 
     
    43384314/** 
    43394315 * Call major cache updating functions for list of Post objects. 
    43404316 * 
    4341  * @package WordPress 
    4342  * @subpackage Cache 
    43434317 * @since 1.5.0 
    43444318 * 
    43454319 * @uses $wpdb 
     
    43934367 * metadata cache for the posts. Therefore, the functions, which call this 
    43944368 * function, do not need to perform SQL queries on their own. 
    43954369 * 
    4396  * @package WordPress 
    4397  * @subpackage Cache 
    43984370 * @since 2.1.0 
    43994371 * 
    44004372 * @uses $wpdb 
     
    44154387 * This function will not run if $_wp_suspend_cache_invalidation is not empty. See 
    44164388 * wp_suspend_cache_invalidation(). 
    44174389 * 
    4418  * @package WordPress 
    4419  * @subpackage Cache 
    44204390 * @since 3.0.0 
    44214391 * 
    44224392 * @uses do_action() Calls 'clean_attachment_cache' on $id. 
     
    46104580 * to be insterted into the posts table as a post revision. Otherwise, returns 
    46114581 * an array whose keys are the post fields to be saved for post revisions. 
    46124582 * 
    4613  * @package WordPress 
    4614  * @subpackage Post_Revisions 
    46154583 * @since 2.6.0 
    46164584 * @access private 
    46174585 * @uses apply_filters() Calls '_wp_post_revision_fields' on 'title', 'content' and 'excerpt' fields. 
     
    46614629 * 
    46624630 * Typically used immediately prior to post updates. 
    46634631 * 
    4664  * @package WordPress 
    4665  * @subpackage Post_Revisions 
    46664632 * @since 2.6.0 
    46674633 * 
    46684634 * @uses _wp_put_post_revision() 
     
    47174683 * Returns a post object containing the information that was autosaved for the 
    47184684 * specified post. 
    47194685 * 
    4720  * @package WordPress 
    4721  * @subpackage Post_Revisions 
    47224686 * @since 2.6.0 
    47234687 * 
    47244688 * @param int $post_id The post ID. 
     
    47524716/** 
    47534717 * Internally used to hack WP_Query into submission. 
    47544718 * 
    4755  * @package WordPress 
    4756  * @subpackage Post_Revisions 
    47574719 * @since 2.6.0 
    47584720 * 
    47594721 * @param object $query WP_Query object 
     
    47654727/** 
    47664728 * Determines if the specified post is a revision. 
    47674729 * 
    4768  * @package WordPress 
    4769  * @subpackage Post_Revisions 
    47704730 * @since 2.6.0 
    47714731 * 
    47724732 * @param int|object $post Post ID or post object. 
     
    47814741/** 
    47824742 * Determines if the specified post is an autosave. 
    47834743 * 
    4784  * @package WordPress 
    4785  * @subpackage Post_Revisions 
    47864744 * @since 2.6.0 
    47874745 * 
    47884746 * @param int|object $post Post ID or post object. 
     
    47994757/** 
    48004758 * Inserts post data into the posts table as a post revision. 
    48014759 * 
    4802  * @package WordPress 
    4803  * @subpackage Post_Revisions 
    48044760 * @since 2.6.0 
    48054761 * 
    48064762 * @uses wp_insert_post() 
     
    48354791/** 
    48364792 * Gets a post revision. 
    48374793 * 
    4838  * @package WordPress 
    4839  * @subpackage Post_Revisions 
    48404794 * @since 2.6.0 
    48414795 * 
    48424796 * @uses get_post() 
     
    48714825 * 
    48724826 * Can restore a past revision using all fields of the post revision, or only selected fields. 
    48734827 * 
    4874  * @package WordPress 
    4875  * @subpackage Post_Revisions 
    48764828 * @since 2.6.0 
    48774829 * 
    48784830 * @uses wp_get_post_revision() 
     
    49174869 * 
    49184870 * Deletes the row from the posts table corresponding to the specified revision. 
    49194871 * 
    4920  * @package WordPress 
    4921  * @subpackage Post_Revisions 
    49224872 * @since 2.6.0 
    49234873 * 
    49244874 * @uses wp_get_post_revision() 
     
    49444894/** 
    49454895 * Returns all revisions of specified post. 
    49464896 * 
    4947  * @package WordPress 
    4948  * @subpackage Post_Revisions 
    49494897 * @since 2.6.0 
    49504898 * 
    49514899 * @uses get_children() 
  • wp-includes/comment.php

     
    376376 * Comments have a limited set of valid status values, this provides the comment 
    377377 * status values and descriptions. 
    378378 * 
    379  * @package WordPress 
    380  * @subpackage Post 
    381379 * @since 2.7.0 
    382380 * 
    383381 * @return array List of comment statuses. 
     
    19181916 * Removes comment ID from the comment cache. 
    19191917 * 
    19201918 * @since 2.3.0 
    1921  * @package WordPress 
    1922  * @subpackage Cache 
    19231919 * 
    19241920 * @param int|array $ids Comment ID or array of comment IDs to remove from cache 
    19251921 */ 
     
    19381934 * cache using the comment group with the key using the ID of the comments. 
    19391935 * 
    19401936 * @since 2.3.0 
    1941  * @package WordPress 
    1942  * @subpackage Cache 
    19431937 * 
    19441938 * @param array $comments Array of comment row objects 
    19451939 */ 
  • wp-includes/functions.php

     
    314314 * If the option was serialized then it will be unserialized when it is returned. 
    315315 * 
    316316 * @since 1.5.0 
    317  * @package WordPress 
    318  * @subpackage Option 
    319317 * @uses apply_filters() Calls 'pre_option_$option' before checking the option. 
    320318 *      Any value other than false will "short-circuit" the retrieval of the option 
    321319 *      and return the returned value. You should not try to override special options, 
     
    395393 * and 'notoptions' options. 
    396394 * 
    397395 * @since 2.2.0 
    398  * @package WordPress 
    399  * @subpackage Option 
    400396 * 
    401397 * @param string $option Option name. 
    402398 */ 
     
    411407 * 
    412408 * @uses attr Sanitizes value. 
    413409 * @since 1.5.0 
    414  * @package WordPress 
    415  * @subpackage Option 
    416410 * 
    417411 * @param string $option Option name. 
    418412 */ 
     
    424418 * Loads and caches all autoloaded options, if available or all options. 
    425419 * 
    426420 * @since 2.2.0 
    427  * @package WordPress 
    428  * @subpackage Option 
    429421 * 
    430422 * @return array List of all options. 
    431423 */ 
     
    457449 * Loads and caches certain often requested site options if is_multisite() and a peristent cache is not being used. 
    458450 * 
    459451 * @since 3.0.0 
    460  * @package WordPress 
    461  * @subpackage Option 
    462452 * 
    463453 * @param int $site_id Optional site ID for which to query the options. Defaults to the current site. 
    464454 */ 
     
    497487 * to set whether an option is autoloaded, then you need to use the add_option(). 
    498488 * 
    499489 * @since 1.0.0 
    500  * @package WordPress 
    501  * @subpackage Option 
    502490 * 
    503491 * @uses apply_filters() Calls 'pre_update_option_$option' hook to allow overwriting the 
    504492 *      option value to be stored. 
     
    575563 * options the same as the ones which are protected and to not add options 
    576564 * that were already added. 
    577565 * 
    578  * @package WordPress 
    579  * @subpackage Option 
    580566 * @since 1.0.0 
    581567 * 
    582568 * @uses do_action() Calls 'add_option' hook before adding the option. 
     
    649635/** 
    650636 * Removes option by name. Prevents removal of protected WordPress options. 
    651637 * 
    652  * @package WordPress 
    653  * @subpackage Option 
    654638 * @since 1.2.0 
    655639 * 
    656640 * @uses do_action() Calls 'delete_option' hook before option is deleted. 
     
    693677 * Delete a transient 
    694678 * 
    695679 * @since 2.8.0 
    696  * @package WordPress 
    697  * @subpackage Transient 
    698680 * 
    699681 * @uses do_action() Calls 'delete_transient_$transient' hook before transient is deleted. 
    700682 * @uses do_action() Calls 'deleted_transient' hook on success. 
     
    735717 *      the transient value. 
    736718 * 
    737719 * @since 2.8.0 
    738  * @package WordPress 
    739  * @subpackage Transient 
    740720 * 
    741721 * @param string $transient Transient name. Expected to not be SQL-escaped 
    742722 * @return mixed Value of transient 
     
    778758 * it will be serialized before it is set. 
    779759 * 
    780760 * @since 2.8.0 
    781  * @package WordPress 
    782  * @subpackage Transient 
    783761 * 
    784762 * @uses apply_filters() Calls 'pre_set_transient_$transient' hook to allow overwriting the 
    785763 *      transient value to be stored. 
     
    827805 * cookie exists (different browser used), adds the last saved cookie restoring 
    828806 * the settings. 
    829807 * 
    830  * @package WordPress 
    831  * @subpackage Option 
    832808 * @since 2.7.0 
    833809 */ 
    834810function wp_user_settings() { 
     
    870846/** 
    871847 * Retrieve user interface setting value based on setting name. 
    872848 * 
    873  * @package WordPress 
    874  * @subpackage Option 
    875849 * @since 2.7.0 
    876850 * 
    877851 * @param string $name The name of the setting. 
     
    891865 * Both $name and $value can contain only ASCII letters, numbers and underscores. 
    892866 * This function has to be used before any output has started as it calls setcookie(). 
    893867 * 
    894  * @package WordPress 
    895  * @subpackage Option 
    896868 * @since 2.8.0 
    897869 * 
    898870 * @param string $name The name of the setting. 
     
    921893 * Deleting settings would reset them to the defaults. 
    922894 * This function has to be used before any output has started as it calls setcookie(). 
    923895 * 
    924  * @package WordPress 
    925  * @subpackage Option 
    926896 * @since 2.7.0 
    927897 * 
    928898 * @param mixed $names The name or array of names of the setting to be deleted. 
     
    952922/** 
    953923 * Retrieve all user interface settings. 
    954924 * 
    955  * @package WordPress 
    956  * @subpackage Option 
    957925 * @since 2.7.0 
    958926 * 
    959927 * @return array the last saved user settings or empty array. 
     
    986954/** 
    987955 * Private. Set all user interface settings. 
    988956 * 
    989  * @package WordPress 
    990  * @subpackage Option 
    991957 * @since 2.8.0 
    992958 * 
    993959 * @param unknown $all 
     
    1017983/** 
    1018984 * Delete the user settings of the current user. 
    1019985 * 
    1020  * @package WordPress 
    1021  * @subpackage Option 
    1022986 * @since 2.7.0 
    1023987 */ 
    1024988function delete_all_user_settings() { 
     
    10531017 * If the title element is not part of the XML, then the default post title from 
    10541018 * the $post_default_title will be used instead. 
    10551019 * 
    1056  * @package WordPress 
    1057  * @subpackage XMLRPC 
    10581020 * @since 0.71 
    10591021 * 
    10601022 * @global string $post_default_title Default XMLRPC post title. 
     
    10791041 * used. The return type then would be what $post_default_category. If the 
    10801042 * category is found, then it will always be an array. 
    10811043 * 
    1082  * @package WordPress 
    1083  * @subpackage XMLRPC 
    10841044 * @since 0.71 
    10851045 * 
    10861046 * @global string $post_default_category Default XMLRPC post category. 
     
    11021062/** 
    11031063 * XMLRPC XML content without title and category elements. 
    11041064 * 
    1105  * @package WordPress 
    1106  * @subpackage XMLRPC 
    11071065 * @since 0.71 
    11081066 * 
    11091067 * @param string $content XMLRPC XML Request content 
     
    11231081 * to be used in anywhere. 
    11241082 * 
    11251083 * @see fopen() for mode options. 
    1126  * @package WordPress 
    1127  * @subpackage Debug 
    11281084 * @since 0.71 
    11291085 * @uses $debug Used for whether debugging is enabled. 
    11301086 * 
     
    11481104 * Technically, this can be used to write to any file handle when the global 
    11491105 * $debug is set to 1 or true. 
    11501106 * 
    1151  * @package WordPress 
    1152  * @subpackage Debug 
    11531107 * @since 0.71 
    11541108 * @uses $debug Used for whether debugging is enabled. 
    11551109 * 
     
    11681122 * Technically, this can be used to close any file handle when the global $debug 
    11691123 * is set to 1 or true. 
    11701124 * 
    1171  * @package WordPress 
    1172  * @subpackage Debug 
    11731125 * @since 0.71 
    11741126 * @uses $debug Used for whether debugging is enabled. 
    11751127 * 
     
    11881140 * remove enclosures that are no longer in the post. This is called as 
    11891141 * pingbacks and trackbacks. 
    11901142 * 
    1191  * @package WordPress 
    11921143 * @since 1.5.0 
    11931144 * 
    11941145 * @uses $wpdb 
     
    19331884/** 
    19341885 * Retrieve URL with nonce added to URL query. 
    19351886 * 
    1936  * @package WordPress 
    1937  * @subpackage Security 
    19381887 * @since 2.0.4 
    19391888 * 
    19401889 * @param string $actionurl URL to add nonce action 
     
    19691918 * The input name will be whatever $name value you gave. The input value will be 
    19701919 * the nonce creation value. 
    19711920 * 
    1972  * @package WordPress 
    1973  * @subpackage Security 
    19741921 * @since 2.0.4 
    19751922 * 
    19761923 * @param string $action Optional. Action name. 
     
    19971944 * The referer link is the current Request URI from the server super global. The 
    19981945 * input name is '_wp_http_referer', in case you wanted to check manually. 
    19991946 * 
    2000  * @package WordPress 
    2001  * @subpackage Security 
    20021947 * @since 2.0.4 
    20031948 * 
    20041949 * @param bool $echo Whether to echo or return the referer field. 
     
    20201965 * value of {@link wp_referer_field()}, if that was posted already or it will 
    20211966 * be the current page, if it doesn't exist. 
    20221967 * 
    2023  * @package WordPress 
    2024  * @subpackage Security 
    20251968 * @since 2.0.4 
    20261969 * 
    20271970 * @param bool $echo Whether to echo the original http referer 
     
    20401983/** 
    20411984 * Retrieve referer from '_wp_http_referer', HTTP referer, or current page respectively. 
    20421985 * 
    2043  * @package WordPress 
    2044  * @subpackage Security 
    20451986 * @since 2.0.4 
    20461987 * 
    20471988 * @return string|bool False on failure. Referer URL on success. 
     
    20612002/** 
    20622003 * Retrieve original referer that was posted, if it exists. 
    20632004 * 
    2064  * @package WordPress 
    2065  * @subpackage Security 
    20662005 * @since 2.0.4 
    20672006 * 
    20682007 * @return string|bool False if no original referer or original referer if set. 
     
    24252364/** 
    24262365 * Retrieve the file type based on the extension name. 
    24272366 * 
    2428  * @package WordPress 
    24292367 * @since 2.5.0 
    24302368 * @uses apply_filters() Calls 'ext2type' hook on default supported types. 
    24312369 * 
     
    26382576 * hook are the localized "Are you sure you want to do this?" message with the 
    26392577 * extra text (the text after the underscore). 
    26402578 * 
    2641  * @package WordPress 
    2642  * @subpackage Security 
    26432579 * @since 2.0.4 
    26442580 * 
    26452581 * @param string $action Nonce action. 
     
    27262662 * If the action has the nonce explain message, then it will be displayed along 
    27272663 * with the "Are you sure?" message. 
    27282664 * 
    2729  * @package WordPress 
    2730  * @subpackage Security 
    27312665 * @since 2.0.4 
    27322666 * 
    27332667 * @param string $action The nonce action. 
     
    29082842 * development environment. 
    29092843 * 
    29102844 * @access private 
    2911  * @package WordPress 
    29122845 * @since 2.2.0 
    29132846 * 
    29142847 * @param string $url URL for the home location 
     
    29282861 * your localhost while not having to change the database to your URL. 
    29292862 * 
    29302863 * @access private 
    2931  * @package WordPress 
    29322864 * @since 2.2.0 
    29332865 * 
    29342866 * @param string $url URL to set the WordPress site location. 
     
    29502882 * keys. These keys are then returned in the $input array. 
    29512883 * 
    29522884 * @access private 
    2953  * @package WordPress 
    2954  * @subpackage MCE 
    29552885 * @since 2.1.0 
    29562886 * 
    29572887 * @param array $input MCE plugin array. 
     
    33653295 * 
    33663296 * This function is to be used in every function that is deprecated. 
    33673297 * 
    3368  * @package WordPress 
    3369  * @subpackage Debug 
    33703298 * @since 2.5.0 
    33713299 * @access private 
    33723300 * 
     
    34033331 * 
    34043332 * This function is to be used in every file that is deprecated. 
    34053333 * 
    3406  * @package WordPress 
    3407  * @subpackage Debug 
    34083334 * @since 2.5.0 
    34093335 * @access private 
    34103336 * 
     
    34493375 * 
    34503376 * The current behavior is to trigger a user error if WP_DEBUG is true. 
    34513377 * 
    3452  * @package WordPress 
    3453  * @subpackage Debug 
    34543378 * @since 3.0.0 
    34553379 * @access private 
    34563380 * 
     
    34853409 * 
    34863410 * The current behavior is to trigger a user error if WP_DEBUG is true. 
    34873411 * 
    3488  * @package WordPress 
    3489  * @subpackage Debug 
    34903412 * @since 3.1.0 
    34913413 * @access private 
    34923414 * 
     
    37123634 * Retrieve site option value based on name of option. 
    37133635 * 
    37143636 * @see get_option() 
    3715  * @package WordPress 
    3716  * @subpackage Option 
    37173637 * @since 2.8.0 
    37183638 * 
    37193639 * @uses apply_filters() Calls 'pre_site_option_$option' before checking the option. 
     
    37643684 * Add a new site option. 
    37653685 * 
    37663686 * @see add_option() 
    3767  * @package WordPress 
    3768  * @subpackage Option 
    37693687 * @since 2.8.0 
    37703688 * 
    37713689 * @uses apply_filters() Calls 'pre_add_site_option_$option' hook to allow overwriting the 
     
    38083726 * Removes site option by name. 
    38093727 * 
    38103728 * @see delete_option() 
    3811  * @package WordPress 
    3812  * @subpackage Option 
    38133729 * @since 2.8.0 
    38143730 * 
    38153731 * @uses do_action() Calls 'pre_delete_site_option_$option' hook before option is deleted. 
     
    38513767 * 
    38523768 * @see update_option() 
    38533769 * @since 2.8.0 
    3854  * @package WordPress 
    3855  * @subpackage Option 
    38563770 * 
    38573771 * @uses apply_filters() Calls 'pre_update_site_option_$option' hook to allow overwriting the 
    38583772 *      option value to be stored. 
     
    38993813 * Delete a site transient 
    39003814 * 
    39013815 * @since 2.9.0 
    3902  * @package WordPress 
    3903  * @subpackage Transient 
    39043816 * 
    39053817 * @uses do_action() Calls 'delete_site_transient_$transient' hook before transient is deleted. 
    39063818 * @uses do_action() Calls 'deleted_site_transient' hook on success. 
     
    39343846 * 
    39353847 * @see get_transient() 
    39363848 * @since 2.9.0 
    3937  * @package WordPress 
    3938  * @subpackage Transient 
    39393849 * 
    39403850 * @uses apply_filters() Calls 'pre_site_transient_$transient' hook before checking the transient. 
    39413851 *      Any value other than false will "short-circuit" the retrieval of the transient 
     
    39833893 * 
    39843894 * @see set_transient() 
    39853895 * @since 2.9.0 
    3986  * @package WordPress 
    3987  * @subpackage Transient 
    39883896 * 
    39893897 * @uses apply_filters() Calls 'pre_set_site_transient_$transient' hook to allow overwriting the 
    39903898 *      transient value to be stored. 
     
    40253933/** 
    40263934 * is main site 
    40273935 * 
    4028  * 
    40293936 * @since 3.0.0 
    4030  * @package WordPress 
    40313937 * 
    40323938 * @param int $blog_id optional blog id to test (default current blog) 
    40333939 * @return bool True if not multisite or $blog_id is main site 
     
    40473953/** 
    40483954 * Whether global terms are enabled. 
    40493955 * 
    4050  * 
    40513956 * @since 3.0.0 
    4052  * @package WordPress 
    40533957 * 
    40543958 * @return bool True if multisite and global terms enabled 
    40553959 */ 
  • wp-includes/link-template.php

     
    502502 * anchor. If no link text is specified, default text is used. If no post ID is 
    503503 * specified, the current post is used. 
    504504 * 
    505  * @package WordPress 
    506  * @subpackage Feed 
    507505 * @since 2.5.0 
    508506 * 
    509507 * @param string $link_text Descriptive text. 
     
    525523 * Returns a link to the feed for all posts by a given author. A specific feed 
    526524 * can be requested or left blank to get the default feed. 
    527525 * 
    528  * @package WordPress 
    529  * @subpackage Feed 
    530526 * @since 2.5.0 
    531527 * 
    532528 * @param int $author_id ID of an author. 
     
    563559 * Returns a link to the feed for all post in a given category. A specific feed 
    564560 * can be requested or left blank to get the default feed. 
    565561 * 
    566  * @package WordPress 
    567  * @subpackage Feed 
    568562 * @since 2.5.0 
    569563 * 
    570564 * @param int $cat_id ID of a category. 
     
    19291923 * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is 
    19301924 * overridden. 
    19311925 * 
    1932  * @package WordPress 
    19331926 * @since 3.0.0 
    19341927 * 
    19351928 * @uses get_home_url() 
     
    19491942 * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is 
    19501943 * overridden. 
    19511944 * 
    1952  * @package WordPress 
    19531945 * @since 3.0.0 
    19541946 * 
    19551947 * @param  int $blog_id   (optional) Blog ID. Defaults to current blog. 
     
    19841976 * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is 
    19851977 * overridden. 
    19861978 * 
    1987  * @package WordPress 
    19881979 * @since 2.6.0 
    19891980 * 
    19901981 * @uses get_site_url() 
     
    20041995 * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is 
    20051996 * overridden. 
    20061997 * 
    2007  * @package WordPress 
    20081998 * @since 3.0.0 
    20091999 * 
    20102000 * @param int $blog_id (optional) Blog ID. Defaults to current blog. 
     
    20432033/** 
    20442034 * Retrieve the url to the admin area for the current site. 
    20452035 * 
    2046  * @package WordPress 
    20472036 * @since 2.6.0 
    20482037 * 
    20492038 * @param string $path Optional path relative to the admin url 
     
    20572046/** 
    20582047 * Retrieve the url to the admin area for a given site. 
    20592048 * 
    2060  * @package WordPress 
    20612049 * @since 3.0.0 
    20622050 * 
    20632051 * @param int $blog_id (optional) Blog ID. Defaults to current blog. 
     
    20772065/** 
    20782066 * Retrieve the url to the includes directory. 
    20792067 * 
    2080  * @package WordPress 
    20812068 * @since 2.6.0 
    20822069 * 
    20832070 * @param string $path Optional. Path relative to the includes url. 
     
    20952082/** 
    20962083 * Retrieve the url to the content directory. 
    20972084 * 
    2098  * @package WordPress 
    20992085 * @since 2.6.0 
    21002086 * 
    21012087 * @param string $path Optional. Path relative to the content url. 
     
    21162102 * Retrieve the url to the plugins directory or to a specific file within that directory. 
    21172103 * You can hardcode the plugin slug in $path or pass __FILE__ as a second argument to get the correct folder name. 
    21182104 * 
    2119  * @package WordPress 
    21202105 * @since 2.6.0 
    21212106 * 
    21222107 * @param string $path Optional. Path relative to the plugins url. 
     
    21582143 * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is 
    21592144 * overridden. 
    21602145 * 
    2161  * @package WordPress 
    21622146 * @since 3.0.0 
    21632147 * 
    21642148 * @param string $path Optional. Path relative to the site url. 
     
    21982182 * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is 
    21992183 * overridden. 
    22002184 * 
    2201  * @package WordPress 
    22022185 * @since 3.0.0 
    22032186 * 
    22042187 * @param  string $path   (optional) Path relative to the home url. 
     
    22272210/** 
    22282211 * Retrieve the url to the admin area for the network. 
    22292212 * 
    2230  * @package WordPress 
    22312213 * @since 3.0.0 
    22322214 * 
    22332215 * @param string $path Optional path relative to the admin url 
     
    22492231/** 
    22502232 * Retrieve the url to the admin area for the current user. 
    22512233 * 
    2252  * @package WordPress 
    22532234 * @since 3.0.0 
    22542235 * 
    22552236 * @param string $path Optional path relative to the admin url 
     
    22682249/** 
    22692250 * Retrieve the url to the admin area for either the current blog or the network depending on context. 
    22702251 * 
    2271  * @package WordPress 
    22722252 * @since 3.1.0 
    22732253 * 
    22742254 * @param string $path Optional path relative to the admin url 
     
    23472327/** 
    23482328 * Output rel=canonical for singular queries 
    23492329 * 
    2350  * @package WordPress 
    23512330 * @since 2.9.0 
    23522331*/ 
    23532332function rel_canonical() { 
  • wp-includes/class-wp-walker.php

     
    251251         * and number of elements per page, this function first determines all top level root elements 
    252252         * belonging to that page, then lists them and all of their children in hierarchical order. 
    253253         * 
    254          * @package WordPress 
    255254         * @since 2.7 
    256255         * @param int $max_depth = 0 means display all levels; $max_depth > 0 specifies the number of display levels. 
    257256         * @param int $page_num the specific page number, beginning with 1. 
  • wp-includes/general-template.php

     
    21142114 * $file is a file relative to wp-admin/ without its ".css" extension. A 
    21152115 * stylesheet link to that generated URL is printed. 
    21162116 * 
    2117  * @package WordPress 
    21182117 * @since 2.3.0 
    21192118 * @uses $wp_styles WordPress Styles Object 
    21202119 * 
  • wp-includes/deprecated.php

     
    16871687 * dots added to the end. If there is content left over, then dots will be added 
    16881688 * and the rest of the content will be removed. 
    16891689 * 
    1690  * @package WordPress 
    1691  * @subpackage Feed 
    16921690 * @since 0.71 
    16931691 * @uses apply_filters() Calls 'the_content_rss' on the content before processing. 
    16941692 * @see get_the_content() For the $more_link_text, $stripteaser, and $more_file 
  • wp-includes/feed.php

     
    1616 * Everything will be stripped of tags and characters converted, when the values 
    1717 * are retrieved for use in the feeds. 
    1818 * 
    19  * @package WordPress 
    20  * @subpackage Feed 
    2119 * @since 1.5.1 
    2220 * @uses apply_filters() Calls 'get_bloginfo_rss' hook with two parameters. 
    2321 * @see get_bloginfo() For the list of possible values to display. 
     
    3735 * Everything will be stripped of tags and characters converted, when the values 
    3836 * are retrieved for use in the feeds. 
    3937 * 
    40  * @package WordPress 
    41  * @subpackage Feed 
    4238 * @since 0.71 
    4339 * @uses apply_filters() Calls 'bloginfo_rss' hook with two parameters. 
    4440 * @see get_bloginfo() For the list of possible values to display. 
     
    5551 * The default feed is 'rss2', unless a plugin changes it through the 
    5652 * 'default_feed' filter. 
    5753 * 
    58  * @package WordPress 
    59  * @subpackage Feed 
    6054 * @since 2.5 
    6155 * @uses apply_filters() Calls 'default_feed' hook on the default feed string. 
    6256 * 
     
    6963/** 
    7064 * Retrieve the blog title for the feed title. 
    7165 * 
    72  * @package WordPress 
    73  * @subpackage Feed 
    7466 * @since 2.2.0 
    7567 * @uses apply_filters() Calls 'get_wp_title_rss' hook on title. 
    7668 * @uses wp_title() See function for $sep parameter usage. 
     
    8981/** 
    9082 * Display the blog title for display of the feed title. 
    9183 * 
    92  * @package WordPress 
    93  * @subpackage Feed 
    9484 * @since 2.2.0 
    9585 * @uses apply_filters() Calls 'wp_title_rss' on the blog title. 
    9686 * @see wp_title() $sep parameter usage. 
     
    10494/** 
    10595 * Retrieve the current post title for the feed. 
    10696 * 
    107  * @package WordPress 
    108  * @subpackage Feed 
    10997 * @since 2.0.0 
    11098 * @uses apply_filters() Calls 'the_title_rss' on the post title. 
    11199 * 
     
    120108/** 
    121109 * Display the post title in the feed. 
    122110 * 
    123  * @package WordPress 
    124  * @subpackage Feed 
    125111 * @since 0.71 
    126112 * @uses get_the_title_rss() Used to retrieve current post title. 
    127113 */ 
     
    132118/** 
    133119 * Retrieve the post content for feeds. 
    134120 * 
    135  * @package WordPress 
    136  * @subpackage Feed 
    137121 * @since 2.9.0 
    138122 * @uses apply_filters() Calls 'the_content_feed' on the content before processing. 
    139123 * @see get_the_content() 
     
    152136/** 
    153137 * Display the post content for feeds. 
    154138 * 
    155  * @package WordPress 
    156  * @subpackage Feed 
    157139 * @since 2.9.0 
    158140 * @uses apply_filters() Calls 'the_content_feed' on the content before processing. 
    159141 * @see get_the_content() 
     
    167149/** 
    168150 * Display the post excerpt for the feed. 
    169151 * 
    170  * @package WordPress 
    171  * @subpackage Feed 
    172152 * @since 0.71 
    173153 * @uses apply_filters() Calls 'the_excerpt_rss' hook on the excerpt. 
    174154 */ 
     
    180160/** 
    181161 * Display the permalink to the post for use in feeds. 
    182162 * 
    183  * @package WordPress 
    184  * @subpackage Feed 
    185163 * @since 2.3.0 
    186164 * @uses apply_filters() Call 'the_permalink_rss' on the post permalink 
    187165 */ 
     
    202180/** 
    203181 * Display the feed GUID for the current comment. 
    204182 * 
    205  * @package WordPress 
    206  * @subpackage Feed 
    207183 * @since 2.5.0 
    208184 * 
    209185 * @param int|object $comment_id Optional comment object or id. Defaults to global comment object. 
     
    215191/** 
    216192 * Retrieve the feed GUID for the current comment. 
    217193 * 
    218  * @package WordPress 
    219  * @subpackage Feed 
    220194 * @since 2.5.0 
    221195 * 
    222196 * @param int|object $comment_id Optional comment object or id. Defaults to global comment object. 
     
    243217/** 
    244218 * Retrieve the current comment author for use in the feeds. 
    245219 * 
    246  * @package WordPress 
    247  * @subpackage Feed 
    248220 * @since 2.0.0 
    249221 * @uses apply_filters() Calls 'comment_author_rss' hook on comment author. 
    250222 * @uses get_comment_author() 
     
    258230/** 
    259231 * Display the current comment author in the feed. 
    260232 * 
    261  * @package WordPress 
    262  * @subpackage Feed 
    263233 * @since 1.0.0 
    264234 */ 
    265235function comment_author_rss() { 
     
    269239/** 
    270240 * Display the current comment content for use in the feeds. 
    271241 * 
    272  * @package WordPress 
    273  * @subpackage Feed 
    274242 * @since 1.0.0 
    275243 * @uses apply_filters() Calls 'comment_text_rss' filter on comment content. 
    276244 * @uses get_comment_text() 
     
    288256 * retrieved and have feed markup added, so that they can easily be added to the 
    289257 * RSS2, Atom, or RSS1 and RSS0.91 RDF feeds. 
    290258 * 
    291  * @package WordPress 
    292  * @subpackage Feed 
    293259 * @since 2.1.0 
    294260 * @uses apply_filters() 
    295261 * 
     
    333299/** 
    334300 * Display the post categories in the feed. 
    335301 * 
    336  * @package WordPress 
    337  * @subpackage Feed 
    338302 * @since 0.71 
    339303 * @see get_the_category_rss() For better explanation. 
    340304 * 
     
    349313 * 
    350314 * The two possible values are either 'xhtml' or 'html'. 
    351315 * 
    352  * @package WordPress 
    353  * @subpackage Feed 
    354316 * @since 2.2.0 
    355317 */ 
    356318function html_type_rss() { 
     
    374336 * enclosure(s) consist of enclosure HTML tag(s) with a URI and other 
    375337 * attributes. 
    376338 * 
    377  * @package WordPress 
    378  * @subpackage Template 
    379339 * @since 1.5.0 
    380340 * @uses apply_filters() Calls 'rss_enclosure' hook on rss enclosure. 
    381341 * @uses get_post_custom() To get the current post enclosure metadata. 
     
    410370 * metadata field and parses the value to display the enclosure(s). The 
    411371 * enclosure(s) consist of link HTML tag(s) with a URI and other attributes. 
    412372 * 
    413  * @package WordPress 
    414  * @subpackage Template 
    415373 * @since 2.2.0 
    416374 * @uses apply_filters() Calls 'atom_enclosure' hook on atom enclosure. 
    417375 * @uses get_post_custom() To get the current post enclosure metadata. 
     
    442400 * 
    443401 * @link http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.3.1 
    444402 * 
    445  * @package WordPress 
    446  * @subpackage Feed 
    447403 * @since 2.5 
    448404 * 
    449405 * @param string $data Input string 
     
    480436 * 
    481437 * Generate a correct link for the atom:self element. 
    482438 * 
    483  * @package WordPress 
    484  * @subpackage Feed 
    485439 * @since 2.5 
    486440 */ 
    487441function self_link() { 
     
    498452/** 
    499453 * Return the content type for specified feed type. 
    500454 * 
    501  * @package WordPress 
    502  * @subpackage Feed 
    503455 * @since 2.8.0 
    504456 */ 
    505457function feed_content_type( $type = '' ) { 
  • wp-app.php

     
    22/** 
    33 * Atom Publishing Protocol support for WordPress 
    44 * 
     5 * @package WordPress 
     6 * @subpackage Publishing 
    57 * @version 1.0.5-dc 
    68 */ 
    79 
     
    4547 * 
    4648 * @since 2.2.0 
    4749 * @uses $app_logging 
    48  * @package WordPress 
    49  * @subpackage Logging 
    5050 * 
    5151 * @param string $label Type of logging 
    5252 * @param string $msg Information describing logging reason. 
  • xmlrpc.php

     
    7676 * logIO() - Writes logging info to a file. 
    7777 * 
    7878 * @uses $xmlrpc_logging 
    79  * @package WordPress 
    80  * @subpackage Logging 
    8179 * 
    8280 * @param string $io Whether input or output 
    8381 * @param string $msg Information describing logging reason. 
  • wp-admin/includes/class-wp-filesystem-base.php

     
    99/** 
    1010 * Base WordPress Filesystem class for which Filesystem implementations extend 
    1111 * 
     12 * @package WordPress 
     13 * @subpackage Filesystem 
    1214 * @since 2.5 
    1315 */ 
    1416class WP_Filesystem_Base { 
  • wp-admin/includes/post.php

     
    1111 * 
    1212 * Manipulates $_POST directly. 
    1313 * 
    14  * @package WordPress 
    1514 * @since 2.6.0 
    1615 * 
    1716 * @param bool $update Are we updating a pre-existing post? 
     
    12941293/** 
    12951294 * Creates autosave data for the specified post from $_POST data. 
    12961295 * 
    1297  * @package WordPress 
    1298  * @subpackage Post_Revisions 
    12991296 * @since 2.6.0 
    13001297 * 
    13011298 * @uses _wp_translate_postdata() 
     
    13261323/** 
    13271324 * Save draft or manually autosave for showing preview. 
    13281325 * 
    1329  * @package WordPress 
    13301326 * @since 2.7.0 
    13311327 * 
    13321328 * @uses wp_write_post() 
     
    13881384/** 
    13891385 * Adds the TinyMCE editor used on the Write and Edit screens. 
    13901386 * 
    1391  * @package WordPress 
    13921387 * @since 2.7.0 
    13931388 * 
    13941389 * TinyMCE is loaded separately from other Javascript by using wp-tinymce.php. It outputs concatenated 
  • wp-admin/install-helper.php

     
    5555 * Create database table, if it doesn't already exist. 
    5656 * 
    5757 * @since 1.0.0 
    58  * @package WordPress 
    59  * @subpackage Plugin 
    6058 * @uses $wpdb 
    6159 * 
    6260 * @param string $table_name Database table name. 
     
    8785 * Add column to database table, if column doesn't already exist in table. 
    8886 * 
    8987 * @since 1.0.0 
    90  * @package WordPress 
    91  * @subpackage Plugin 
    9288 * @uses $wpdb 
    9389 * @uses $debug 
    9490 * 
     
    122118 * Drop column from database table, if it exists. 
    123119 * 
    124120 * @since 1.0.0 
    125  * @package WordPress 
    126  * @subpackage Plugin 
    127121 * @uses $wpdb 
    128122 * 
    129123 * @param string $table_name Table name 
     
    166160 *      Extra 
    167161 * 
    168162 * @since 1.0.0 
    169  * @package WordPress 
    170  * @subpackage Plugin 
    171163 * 
    172164 * @param string $table_name Table name 
    173165 * @param string $col_name Column name 
  • wp-admin/options-general.php

     
    1919 
    2020/** 
    2121 * Display JavaScript on the page. 
    22  * 
    23  * @package WordPress 
    24  * @subpackage General_Settings_Screen 
    2522 */ 
    2623function add_js() { 
    2724?> 
  • wp-admin/press-this.php

     
    1919/** 
    2020 * Press It form handler. 
    2121 * 
    22  * @package WordPress 
    23  * @subpackage Press_This 
    2422 * @since 2.6.0 
    2523 * 
    2624 * @return int Post ID 
     
    196194                /** 
    197195                 * Retrieve all image URLs from given URI. 
    198196                 * 
    199                  * @package WordPress 
    200                  * @subpackage Press_This 
    201197                 * @since 2.6.0 
    202198                 * 
    203199                 * @param string $uri 
  • wp-admin/options-reading.php

     
    1717 
    1818/** 
    1919 * Display JavaScript on the page. 
    20  * 
    21  * @package WordPress 
    22  * @subpackage Reading_Settings_Screen 
    2320 */ 
    2421function add_js() { 
    2522?> 
  • wp-admin/setup-config.php

     
    7474 * 
    7575 * @ignore 
    7676 * @since 2.3.0 
    77  * @package WordPress 
    78  * @subpackage Installer_WP_Config 
    7977 */ 
    8078function display_header() { 
    8179        header( 'Content-Type: text/html; charset=utf-8' ); 
  • wp-admin/install.php

     
    4747 * Display install header. 
    4848 * 
    4949 * @since 2.5.0 
    50  * @package WordPress 
    51  * @subpackage Installer 
    5250 */ 
    5351function display_header() { 
    5452        header( 'Content-Type: text/html; charset=utf-8' ); 
     
    7068 * Display installer setup form. 
    7169 * 
    7270 * @since 2.8.0 
    73  * @package WordPress 
    74  * @subpackage Installer 
    7571 */ 
    7672function display_setup_form( $error = null ) { 
    7773        global $wpdb; 
  • wp-admin/link-parse-opml.php

     
    7070 * 
    7171 * @since 0.71 
    7272 * @access private 
    73  * @package WordPress 
    74  * @subpackage Dummy 
    7573 * 
    7674 * @param mixed $parser XML Parser resource. 
    7775 * @param string $tagName XML tag name. 
  • wp-admin/options-permalink.php

     
    3030 
    3131/** 
    3232 * Display JavaScript on the page. 
    33  * 
    34  * @package WordPress 
    35  * @subpackage Permalink_Settings_Screen 
    3633 */ 
    3734function add_js() { 
    3835        ?>