WordPress.org

Making WordPress.org


Ignore:
Timestamp:
06/20/2016 05:34:18 PM (4 years ago)
Author:
obenland
Message:

Plugin Directory: Documentation and formatting updates.

See #1584.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-tools.php

    r3510 r3511  
    1212    /**
    1313     * Retrieve the average color of a specified image.
     14     *
    1415     * This currently relies upon the Jetpack libraries.
    1516     *
    16      * @param $file_location string URL or filepath of image
    17      * @return string|bool Average color as a hex value, False on failure
    18      */
    19     static function get_image_average_color( $file_location ) {
     17     * @static
     18     *
     19     * @param $file_location string URL or filepath of image.
     20     * @return string|bool Average color as a hex value, False on failure.
     21     */
     22    public static function get_image_average_color( $file_location ) {
    2023        if ( ! class_exists( 'Tonesque' ) && function_exists( 'jetpack_require_lib' ) ) {
    2124            jetpack_require_lib( 'tonesque' );
    2225        }
     26
    2327        if ( ! class_exists( 'Tonesque' ) ) {
    2428            return false;
    … …  
    3337     * Returns the two latest reviews of a specific plugin.
    3438     *
     39     * @static
    3540     * @global \wpdb $wpdb WordPress database abstraction object.
    3641     *
    … …  
    5459                posts.post_position = 1
    5560            ORDER BY ratings.review_id DESC LIMIT 2", $plugin_slug ) );
     61
    5662            wp_cache_set( "{$plugin_slug}_reviews", $reviews, 'wporg-plugins', HOUR_IN_SECONDS );
    5763        }
    … …  
    6268    /**
    6369     * Retrieve a list of users who have commit to a specific plugin.
     70     *
     71     * @static
     72     * @global \wpdb $wpdb WordPress database abstraction object.
    6473     *
    6574     * @param string $plugin_slug The plugin slug.
    … …  
    6776     */
    6877    public static function get_plugin_committers( $plugin_slug ) {
    69         global $wpdb;
    70 
    7178        if ( false === ( $committers = wp_cache_get( "{$plugin_slug}_committer", 'wporg-plugins' ) ) ) {
     79            global $wpdb;
     80
    7281            $committers = $wpdb->get_col( $wpdb->prepare( 'SELECT user FROM `' . PLUGINS_TABLE_PREFIX . 'svn_access' . '` WHERE path = %s', "/{$plugin_slug}" ) );
    7382
    … …  
    8089    /**
    8190     * Retrieve a list of plugins a specific user has commit to.
     91     *
     92     * @static
     93     * @global \wpdb $wpdb WordPress database abstraction object.
    8294     *
    8395     * @param int|\WP_User $user The user.
    … …  
    8597     */
    8698    public static function get_users_write_access_plugins( $user ) {
    87         global $wpdb;
    8899        if ( ! $user instanceof \WP_User ) {
    89100            $user = new \WP_User( $user );
    90101        }
     102
    91103        if ( ! $user->exists() ) {
    92104            return false;
    … …  
    94106
    95107        if ( false === ( $plugins = wp_cache_get( "{$user->user_login}_committer", 'wporg-plugins' ) ) ) {
     108            global $wpdb;
     109
    96110            $plugins = $wpdb->get_col( $wpdb->prepare( 'SELECT path FROM `' . PLUGINS_TABLE_PREFIX . 'svn_access' . '` WHERE user = %s', $user->user_login ) );
    97             $plugins = array_map( function( $plugin ) { return trim( $plugin, '/' ); }, $plugins );
     111            $plugins = array_map( function ( $plugin ) {
     112                return trim( $plugin, '/' );
     113            }, $plugins );
    98114
    99115            wp_cache_set( "{$user->user_login}_committer", $plugins, 'wporg-plugins' );
    … …  
    101117
    102118        return $plugins;
    103 
    104119    }
    105120
    106121    /**
    107122     * Grant a user RW access to a plugin.
     123     *
     124     * @static
     125     * @global \wpdb $wpdb WordPress database abstraction object.
    108126     *
    109127     * @param string          $plugin_slug The plugin slug.
    … …  
    124142        $existing_committers = self::get_plugin_committers( $plugin_slug );
    125143        if ( in_array( $user->user_login, $existing_committers, true ) ) {
     144
    126145            // User already has write access.
    127146            return true;
    … …  
    131150        wp_cache_delete( "{$user->user_login}_committer", 'wporg-plugins' );
    132151
    133         return (bool) $wpdb->insert(
    134             PLUGINS_TABLE_PREFIX . 'svn_access',
    135             array(
    136                 'path'   => "/{$plugin_slug}",
    137                 'user'   => $user->user_login,
    138                 'access' => 'rw',
    139             )
    140         );
     152        return (bool) $wpdb->insert( PLUGINS_TABLE_PREFIX . 'svn_access', array(
     153            'path'   => "/{$plugin_slug}",
     154            'user'   => $user->user_login,
     155            'access' => 'rw',
     156        ) );
    141157    }
    142158
    143159    /**
    144160     * Revoke a users RW access to a plugin.
     161     *
     162     * @static
     163     * @global \wpdb $wpdb WordPress database abstraction object.
    145164     *
    146165     * @param string          $plugin_slug The plugin slug.
    … …  
    162181        wp_cache_delete( "{$user->user_login}_committer", 'wporg-plugins' );
    163182
    164         return $wpdb->delete(
    165             PLUGINS_TABLE_PREFIX . 'svn_access',
    166             array(
    167                 'path' => "/{$plugin_slug}",
    168                 'user' => $user->user_login,
    169             )
    170         );
     183        return $wpdb->delete( PLUGINS_TABLE_PREFIX . 'svn_access', array(
     184            'path' => "/{$plugin_slug}",
     185            'user' => $user->user_login,
     186        ) );
    171187    }
    172188
    … …  
    177193     * emails and cannot unsubscribe.
    178194     *
     195     * @static
     196     *
    179197     * @param string      $plugin_slug The plugin to subscribe to.
    180      * @param int|WP_User $user        The user to subscribe. Default current user.
    181      * @param bool        $subscribe   Whether to subscribe (true) or unsubscribe (false).
    182      *
     198     * @param int|WP_User $user        Optional. The user to subscribe. Default current user.
     199     * @param bool        $subscribe   Optional. Whether to subscribe (true) or unsubscribe (false).
     200     *                                 Default: true.
    183201     * @return bool Whether the user is subscribed.
    184202     */
    … …  
    216234     * function does not respect that status.
    217235     *
     236     * @static
     237     *
    218238     * @param string      $plugin_slug The plugin to subscribe to.
    219      * @param int|WP_User $user        The user to check. Default current user.
    220      *
     239     * @param int|WP_User $user        Optional. The user to check. Default current user.
    221240     * @return bool Whether the specified user is subscribed to commits.
    222241     */
Note: See TracChangeset for help on using the changeset viewer.