Skip to content
This repository has been archived by the owner on Feb 22, 2022. It is now read-only.

Commit

Permalink
Merge pull request #62 from WordPress/fix/issue-25-new
Browse files Browse the repository at this point in the history 
Documentation: Improve DocBlocks.
  • Loading branch information
@audrasjb
audrasjb committed Apr 6, 2020
2 parents e7a309b + 04eff88 commit 6972991
Showing 1 changed file with 104 additions and 15 deletions.
119 changes: 104 additions & 15 deletions functions.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@


/**
* Enqueue styles and scripts
* Enqueue styles and scripts.
*
* @param string $hook The current admin page.
*/
function wp_autoupdates_enqueues( $hook ) {
if ( ! in_array( $hook, array( 'plugins.php', 'themes.php', 'site-themes.php', 'update-core.php' ) ) ) {
Expand Down Expand Up @@ -120,6 +122,9 @@ function insert_into_template(positioning_text, added_text, insert_before) {

/**
* Filter the themes prepared for JavaScript, for themes.php.
*
* @paran array $prepared_themes Array of theme data.
* @return array
*/
function wp_autoupdates_prepare_themes_for_js( $prepared_themes ) {
$wp_auto_update_themes = get_option( 'wp_auto_update_themes', array() );
Expand All @@ -141,6 +146,8 @@ function wp_autoupdates_prepare_themes_for_js( $prepared_themes ) {

/**
* Checks whether plugins manual auto-update is enabled.
*
* @return bool True if plugins auto-update is enabled, false otherwise.
*/
function wp_autoupdates_is_plugins_auto_update_enabled() {
$enabled = ! defined( 'WP_DISABLE_PLUGINS_AUTO_UPDATE' ) || ! WP_DISABLE_PLUGINS_AUTO_UPDATE;
Expand All @@ -156,6 +163,8 @@ function wp_autoupdates_is_plugins_auto_update_enabled() {

/**
* Checks whether themes manual auto-update is enabled.
*
* @return bool True if themes auto-update is enabled, false otherwise.
*/
function wp_autoupdates_is_themes_auto_update_enabled() {
$enabled = ! defined( 'WP_DISABLE_THEMES_AUTO_UPDATE' ) || ! WP_DISABLE_THEMES_AUTO_UPDATE;
Expand All @@ -171,6 +180,10 @@ function wp_autoupdates_is_themes_auto_update_enabled() {

/**
* Autoupdate selected plugins.
*
* @param bool $update Whether to update.
* @param object The update offer.
* @return bool
*/
function wp_autoupdates_selected_plugins( $update, $item ) {
$wp_auto_update_plugins = get_site_option( 'wp_auto_update_plugins', array() );
Expand All @@ -185,6 +198,10 @@ function wp_autoupdates_selected_plugins( $update, $item ) {

/**
* Autoupdate selected themes.
*
* @param bool $update Whether to update.
* @param object The update offer.
* @return bool
*/
function wp_autoupdates_selected_themes( $update, $item ) {
$wp_auto_update_themes = get_site_option( 'wp_auto_update_themes', array() );
Expand All @@ -199,6 +216,9 @@ function wp_autoupdates_selected_themes( $update, $item ) {

/**
* Add autoupdate column to plugins screen.
*
* @param string[] The column header labels keyed by column ID.
* @return string[]
*/
function wp_autoupdates_add_plugins_autoupdates_column( $columns ) {
if ( ! current_user_can( 'update_plugins' ) || ! wp_autoupdates_is_plugins_auto_update_enabled() ) {
Expand All @@ -212,7 +232,11 @@ function wp_autoupdates_add_plugins_autoupdates_column( $columns ) {
add_filter( is_multisite() ? 'manage_plugins-network_columns' : 'manage_plugins_columns', 'wp_autoupdates_add_plugins_autoupdates_column' );

/**
* Render autoupdate column’s content.
* Render autoupdate column's content.
*
* @param string Name of the column.
* @param string $plugin_file Path to the plugin file relative to the plugins directory.
* @param array $plugin_data An array of plugin data.
*/
function wp_autoupdates_add_plugins_autoupdates_column_content( $column_name, $plugin_file, $plugin_data ) {
if ( ! current_user_can( 'update_plugins' ) || ! wp_autoupdates_is_plugins_auto_update_enabled() ) {
Expand Down Expand Up @@ -283,7 +307,10 @@ function wp_autoupdates_add_plugins_autoupdates_column_content( $column_name, $p


/**
* Add plugins autoupdates bulk actions
* Add plugins autoupdates bulk actions.
*
* @param string[] $actions An array of the available bulk actions.
* @return string[]
*/
function wp_autoupdates_plugins_bulk_actions( $actions ) {
$actions['enable-autoupdate-selected'] = __( 'Enable auto-updates', 'wp-autoupdates' );
Expand All @@ -295,7 +322,7 @@ function wp_autoupdates_plugins_bulk_actions( $actions ) {


/**
* Handles auto-updates enabling for plugins
* Handles auto-updates enabling for plugins.
*/
function wp_autoupdates_plugins_enabler() {
$action = isset( $_GET['action'] ) && ! empty( esc_html( $_GET['action'] ) ) ? wp_unslash( esc_html( $_GET['action'] ) ) : '';
Expand Down Expand Up @@ -392,7 +419,7 @@ function wp_autoupdates_themes_enabler() {


/**
* Handle autoupdates enabling
* Handle autoupdates enabling.
*/
function wp_autoupdates_enabler() {
$pagenow = $GLOBALS['pagenow'];
Expand All @@ -407,7 +434,12 @@ function wp_autoupdates_enabler() {


/**
* Handle plugins autoupdates bulk actions
* Handle plugins autoupdates bulk actions.
*
* @param string $redirect_to The redirect URL.
* @param string $doaction The action being taken.
* @param array $items The items to take the action on. Accepts an array of plugins.
* @return string
*/
function wp_autoupdates_plugins_bulk_actions_handle( $redirect_to, $doaction, $items ) {
if ( 'enable-autoupdate-selected' === $doaction ) {
Expand Down Expand Up @@ -480,7 +512,10 @@ function wp_autoupdates_plugins_bulk_actions_handle( $redirect_to, $doaction, $i


/**
* Handle cleanup when plugin deleted
* Handle cleanup when plugin deleted.
*
* @param string $plugin_file Path to the plugin file relative to the plugins directory.
* @param bool $deleted Whether the plugin deletion was successful.
*/
function wp_autoupdates_plugin_deleted( $plugin_file, $deleted ) {
// Do nothing if the plugin wasn't deleted
Expand All @@ -499,7 +534,7 @@ function wp_autoupdates_plugin_deleted( $plugin_file, $deleted ) {


/**
* Auto-update notices for plugins
* Auto-update notices for plugins.
*/
function wp_autoupdates_plugins_notices() {
if ( isset( $_GET['enable-autoupdate'] ) ) {
Expand All @@ -516,7 +551,7 @@ function wp_autoupdates_plugins_notices() {


/**
* Auto-update notices for themes
* Auto-update notices for themes.
*/
function wp_autoupdates_themes_notices() {
if ( isset( $_GET['enable-autoupdate'] ) ) {
Expand All @@ -533,7 +568,7 @@ function wp_autoupdates_themes_notices() {


/**
* Auto-update notices
* Auto-update notices.
*/
function wp_autoupdates_notices() {
// Plugins screen
Expand All @@ -556,6 +591,9 @@ function wp_autoupdates_notices() {
* then this should be encorporated there.
*
* @global array $totals Counts by plugin_status, set in `WP_Plugins_List_Table::prepare_items()`.
*
* @param string[] $status_links An array of available list table views.
* @return string[]
*/
function wp_autoupdates_plugins_status_links( $status_links ) {
global $totals;
Expand Down Expand Up @@ -633,6 +671,8 @@ function wp_autoupdates_plugins_status_links( $status_links ) {
*
* @global WP_Plugins_List_Table $wp_list_table The global list table object. Set in `wp-admin/plugins.php`.
* @global int $page The current page of plugins displayed. Set in WP_Plugins_List_Table::__construct().
*
* @param array[] $plugins An array of arrays containing information on all installed plugins.
*/
function wp_autoupdates_plugins_filter_plugins_by_status( $plugins ) {
global $wp_list_table, $page;
Expand Down Expand Up @@ -692,8 +732,37 @@ function wp_autoupdates_plugins_filter_plugins_by_status( $plugins ) {
add_action( 'pre_current_active_plugins', 'wp_autoupdates_plugins_filter_plugins_by_status' );


/*
* Populate site health informations
/**
* Populate site health informations.
*
* @param array $args {
* The debug information to be added to the core information page.
*
* This is an associative multi-dimensional array, up to three levels deep. The topmost array holds the sections.
* Each section has a `$fields` associative array (see below), and each `$value` in `$fields` can be
* another associative array of name/value pairs when there is more structured data to display.
*
* @type string $label The title for this section of the debug output.
* @type string $description Optional. A description for your information section which may contain basic HTML
* markup, inline tags only as it is outputted in a paragraph.
* @type boolean $show_count Optional. If set to `true` the amount of fields will be included in the title for
* this section.
* @type boolean $private Optional. If set to `true` the section and all associated fields will be excluded
* from the copied data.
* @type array $fields {
* An associative array containing the data to be displayed.
*
* @type string $label The label for this piece of information.
* @type string $value The output that is displayed for this field. Text should be translated. Can be
* an associative array that is displayed as name/value pairs.
* @type string $debug Optional. The output that is used for this field when the user copies the data.
* It should be more concise and not translated. If not set, the content of `$value` is used.
* Note that the array keys are used as labels for the copied data.
* @type boolean $private Optional. If set to `true` the field will not be included in the copied data
* allowing you to show, for example, API keys here.
* }
* }
* @return array
*/
function wp_autoupdates_debug_information( $info ) {
// Plugins
Expand Down Expand Up @@ -848,6 +917,8 @@ function wp_autoupdates_debug_information( $info ) {

/**
* Checks whether plugins auto-update email notifications are enabled.
*
* @return bool True if plugins notifications are enabled, false otherwise.
*/
function wp_autoupdates_is_plugins_auto_update_email_enabled() {
$enabled = ! defined( 'WP_DISABLE_PLUGINS_AUTO_UPDATE_EMAIL' ) || ! WP_DISABLE_PLUGINS_AUTO_UPDATE;
Expand All @@ -863,6 +934,8 @@ function wp_autoupdates_is_plugins_auto_update_email_enabled() {

/**
* Checks whether themes auto-update email notifications are enabled.
*
* @return bool True if themes notifications are enabled, false otherwise.
*/
function wp_autoupdates_is_themes_auto_update_email_enabled() {
$enabled = ! defined( 'WP_DISABLE_THEMES_AUTO_UPDATE_EMAIL' ) || ! WP_DISABLE_THEMES_AUTO_UPDATE;
Expand Down Expand Up @@ -1016,6 +1089,7 @@ function wp_autoupdates_send_email_notification( $type, $successful_updates, $fa

/**
* Filters the email sent following an automatic background plugin update.
*
* @param array $email {
* Array of email arguments that will be passed to wp_mail().
*
Expand Down Expand Up @@ -1076,6 +1150,9 @@ function wp_autoupdates_get_update_message() {

/**
* Add autoupdate column to network themes screen.
*
* @param string[] The column header labels keyed by column ID.
* @return string[]
*/
function wp_autoupdates_add_themes_autoupdates_column( $columns ) {
if ( ! current_user_can( 'update_themes' ) || ! wp_autoupdates_is_themes_auto_update_enabled() ) {
Expand All @@ -1091,7 +1168,11 @@ function wp_autoupdates_add_themes_autoupdates_column( $columns ) {


/**
* Render autoupdate column’s content.
* Render autoupdate column's content.
*
* @param string Name of the column.
* @param string $stylesheet Directory name of the theme.
* @param WP_Theme $theme Current WP_Theme object.
*/
function wp_autoupdates_add_themes_autoupdates_column_content( $column_name, $stylesheet, $theme ) {
$pagenow = $GLOBALS['pagenow'];
Expand Down Expand Up @@ -1170,7 +1251,10 @@ function wp_autoupdates_add_themes_autoupdates_column_content( $column_name, $st


/**
* Add themes autoupdates bulk actions
* Add themes autoupdates bulk actions.
*
* @param string[] $actions An array of the available bulk actions.
* @return string[]
*/
function wp_autoupdates_themes_bulk_actions( $actions ) {
$actions['enable-autoupdate-selected'] = __( 'Enable auto-updates', 'wp-autoupdates' );
Expand All @@ -1182,7 +1266,12 @@ function wp_autoupdates_themes_bulk_actions( $actions ) {


/**
* Handle themes autoupdates bulk actions
* Handle themes autoupdates bulk actions.
*
* @param string $redirect_to The redirect URL.
* @param string $doaction The action being taken.
* @param array $items The items to take the action on. Accepts an array of themes.
* @return string
*/
function wp_autoupdates_themes_bulk_actions_handle( $redirect_to, $doaction, $items ) {
$pagenow = $GLOBALS['pagenow'];
Expand Down

0 comments on commit 6972991

Please sign in to comment.