WordPress.org

Make WordPress Core


Ignore:
Timestamp:
05/29/2015 08:16:22 PM (6 years ago)
Author:
wonderboymusic
Message:

Add missing doc blocks to wp-admin/includes/*.
Fix some egregious uses of tabbing.
Some functions can simply return apply_filters(...) instead of setting a variable that is immediately returned.

See #32444.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/update.php

    r32653 r32654  
    1010 * Selects the first update version from the update_core option.
    1111 *
    12  * @return bool|object The response from the API on success, false on failure.
     12 * @return object|array|false The response from the API on success, false on failure.
    1313 */
    1414function get_preferred_from_update_core() {
     
    2525 *
    2626 * @param array $options Set $options['dismissed'] to true to show dismissed upgrades too,
    27  *  set $options['available'] to false to skip not-dismissed updates.
    28  * @return bool|array Array of the update objects on success, false on failure.
     27 *                       set $options['available'] to false to skip not-dismissed updates.
     28 * @return array|false Array of the update objects on success, false on failure.
    2929 */
    3030function get_core_updates( $options = array() ) {
     
    6868 * @since 3.7.0
    6969 *
    70  * @return bool|array False on failure, otherwise the core update offering.
     70 * @return array|false False on failure, otherwise the core update offering.
    7171 */
    7272function find_core_auto_update() {
     
    129129}
    130130
     131/**
     132 *
     133 * @param object $update
     134 * @return bool
     135 */
    131136function dismiss_core_update( $update ) {
    132137    $dismissed = get_site_option( 'dismissed_update_core' );
     
    135140}
    136141
     142/**
     143 *
     144 * @param string $version
     145 * @param string $locale
     146 * @return bool
     147 */
    137148function undismiss_core_update( $version, $locale ) {
    138149    $dismissed = get_site_option( 'dismissed_update_core' );
     
    146157}
    147158
     159/**
     160 *
     161 * @param string $version
     162 * @param string $locale
     163 * @return object|false
     164 */
    148165function find_core_update( $version, $locale ) {
    149166    $from_api = get_site_transient( 'update_core' );
     
    160177}
    161178
     179/**
     180 *
     181 * @param string $msg
     182 * @return string
     183 */
    162184function core_update_footer( $msg = '' ) {
    163185    if ( !current_user_can('update_core') )
     
    265287}
    266288
     289/**
     290 *
     291 * @param string $file
     292 * @param array  $plugin_data
     293 * @return false|void
     294 */
    267295function wp_plugin_update_row( $file, $plugin_data ) {
    268296    $current = get_site_transient( 'update_plugins' );
     
    331359}
    332360
     361/**
     362 *
     363 * @return array
     364 */
    333365function get_theme_updates() {
    334366    $current = get_site_transient('update_themes');
     
    360392}
    361393
     394/**
     395 *
     396 * @param string   $theme_key
     397 * @param WP_Theme $theme
     398 * @return false|void
     399 */
    362400function wp_theme_update_row( $theme_key, $theme ) {
    363401    $current = get_site_transient( 'update_themes' );
Note: See TracChangeset for help on using the changeset viewer.