[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

/wp-admin/includes/ -> update.php (summary)

WordPress Administration Update API

File Size: 1379 lines (44 kb)
Included or required: 3 times
Referenced: 0 times
Includes or requires: 4 files
 wp-admin/includes/plugin.php
 wp-admin/includes/class-wp-automatic-updater.php
 wp-admin/includes/class-wp-upgrader.php
 wp-admin/includes/file.php

Defines 28 functions

  get_preferred_from_update_core()
  get_core_updates()
  find_core_auto_update()
  get_core_checksums()
  dismiss_core_update()
  undismiss_core_update()
  find_core_update()
  core_update_footer()
  update_nag()
  update_right_now_message()
  get_plugin_updates()
  wp_plugin_update_rows()
  wp_plugin_update_row()
  get_theme_updates()
  wp_get_translation_update_plugin_names()
  wp_get_translation_update_name()
  wp_get_translation_update_language()
  wp_get_translation_update_data()
  wp_process_translation_update_selection()
  wp_theme_update_rows()
  wp_theme_update_row()
  maintenance_nag()
  wp_print_admin_notice_templates()
  wp_print_update_row_templates()
  wp_recovery_mode_nag()
  wp_is_auto_update_enabled_for_type()
  wp_is_auto_update_forced_for_item()
  wp_get_auto_update_message()

Functions
Functions that are not part of a class:

get_preferred_from_update_core()   X-Ref
Selects the first update version from the update_core option.

return: object|array|false The response from the API on success, false on failure.

get_core_updates( $options = array()   X-Ref
Gets available core updates.

return: array<object>|false Array of the update objects on success, false on failure.
param: array $options Set $options['dismissed'] to true to show dismissed upgrades too,

find_core_auto_update()   X-Ref
Gets the best available (and enabled) Auto-Update for WordPress core.

If there's 1.2.3 and 1.3 on offer, it'll choose 1.3 if the installation allows it, else, 1.2.3.

return: object|false The core update offering on success, false on failure.

get_core_checksums( $version, $locale )   X-Ref
Gets and caches the checksums for the given version of WordPress.

return: array<string, string>|false An array of checksums on success, false on failure.
param: string $version Version string to query.
param: string $locale  Locale to query.

dismiss_core_update( $update )   X-Ref
Dismisses core update.

return: bool True if the option was updated, false otherwise.
param: object $update

undismiss_core_update( $version, $locale )   X-Ref
Undismisses core update.

return: bool True if the option was updated, false otherwise.
param: string $version
param: string $locale

find_core_update( $version, $locale )   X-Ref
Finds the available update for WordPress core.

return: object|false The core update offering on success, false on failure.
param: string $version Version string to find the update for.
param: string $locale  Locale to find the update for.

core_update_footer( $msg = '' )   X-Ref
Returns core update footer message.

return: string The core update footer message.
param: string $msg

update_nag()   X-Ref
Returns core update notification message.

return: void|false Void on success, false if the update nag should not be displayed.

update_right_now_message()   X-Ref
Displays WordPress version and active theme in the 'At a Glance' dashboard widget.


get_plugin_updates()   X-Ref
Retrieves plugins with updates available.

return: array<string, object> Array of plugin objects with available updates.

wp_plugin_update_rows()   X-Ref
Adds a callback to display update information for plugins with updates available.


wp_plugin_update_row( $file, $plugin_data )   X-Ref
Displays update information for a plugin.

return: void|false Void on success, false if the plugin update is not available.
param: string $file        Plugin basename.
param: array  $plugin_data Plugin information.

get_theme_updates()   X-Ref
Retrieves themes with updates available.

return: array<string, WP_Theme> Array of theme objects with available updates.

wp_get_translation_update_plugin_names()   X-Ref
Gets plugin names for translation updates.

return: string[] Plugin names keyed by plugin file, directory, basename, and slug.

wp_get_translation_update_name( $update, $plugin_names = null )   X-Ref
Gets the display name for a translation update.

return: string The translation update name.
param: object        $update       Translation update object.
param: string[]|null $plugin_names Optional. Plugin names keyed by plugin file, directory,

wp_get_translation_update_language( $locale )   X-Ref
Gets the display language for a translation update.

return: string The translation update language.
param: string $locale Translation update locale.

wp_get_translation_update_data()   X-Ref
Gets display data for available translation updates.

return: array[] {

wp_process_translation_update_selection( $translation_update_ids, $selected_translation_update_ids )   X-Ref
Processes a translation update selection and stores the deferred updates.

Only currently available updates included in the submitted form can be selected
or deferred. Previously deferred updates outside the form remain deferred, while
newly available updates outside the form are left unchanged.

The caller must check capabilities and the nonce before calling this function.

return: object[]|false Selected current translation updates keyed by identifier, an empty array
param: string[] $translation_update_ids          Sanitized identifiers of updates included in the form.
param: string[] $selected_translation_update_ids Sanitized identifiers of selected updates.

wp_theme_update_rows()   X-Ref
Adds a callback to display update information for themes with updates available.


wp_theme_update_row( $theme_key, $theme )   X-Ref
Displays update information for a theme.

return: void|false Void on success, false if the theme update is not available.
param: string   $theme_key Theme stylesheet.
param: WP_Theme $theme     Theme object.

maintenance_nag()   X-Ref
Displays maintenance nag HTML message.

return: void|false Void on success, false if the maintenance nag should not be displayed.

wp_print_admin_notice_templates()   X-Ref
Prints the JavaScript templates for update admin notices.


wp_print_update_row_templates()   X-Ref
Prints the JavaScript templates for update and deletion rows in list tables.


wp_recovery_mode_nag()   X-Ref
Displays a notice when the user is in recovery mode.


wp_is_auto_update_enabled_for_type( $type )   X-Ref
Checks whether auto-updates are enabled.

return: bool True if auto-updates are enabled for `$type`, false otherwise.
param: string $type The type of update being checked: Either 'theme' or 'plugin'.

wp_is_auto_update_forced_for_item( $type, $update, $item )   X-Ref
Checks whether auto-updates are forced for an item.

return: bool True if auto-updates are forced for `$item`, false otherwise.
param: string    $type   The type of update being checked: Either 'theme' or 'plugin'.
param: bool|null $update Whether to update. The value of null is internally used
param: object    $item   The update offer.

wp_get_auto_update_message( $type = '' )   X-Ref
Determines the appropriate auto-update message to be displayed.

return: string The update message to be shown.
param: string $type Optional. The type of update the message is for: 'plugin' or 'theme'.



Generated : Sun Nov 8 08:20:01 2026 Cross-referenced by PHPXref