Make WordPress Core


Ignore:
Timestamp:
11/05/2019 09:28:51 PM (5 years ago)
Author:
johnbillion
Message:

Docs: Docs on docs. Further improve documentation of known return types, plus other docs fixes.

See #48303

File:
1 edited

Legend:

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

    r46570 r46662  
    227227 *
    228228 * @param string $plugin Path to the plugin file relative to the plugins directory.
    229  * @return array List of files relative to the plugin root.
     229 * @return string[] Array of file names relative to the plugin root.
    230230 */
    231231function get_plugin_files( $plugin ) {
     
    274274 *
    275275 * @param string $plugin_folder Optional. Relative path to single plugin folder.
    276  * @return array Key is the plugin file path and the value is an array of the plugin data.
     276 * @return array[] Array of arrays of plugin data, keyed by plugin file name. See `get_plugin_data()`.
    277277 */
    278278function get_plugins( $plugin_folder = '' ) {
     
    355355 *
    356356 * @since 3.0.0
    357  * @return array Key is the mu-plugin file path and the value is an array of the mu-plugin data.
     357 * @return array[] Array of arrays of mu-plugin data, keyed by plugin file name. See `get_plugin_data()`.
    358358 */
    359359function get_mu_plugins() {
     
    424424 *
    425425 * @since 3.0.0
    426  * @return array Key is the file path and the value is an array of the plugin data.
     426 * @return array[] Array of arrays of dropin plugin data, keyed by plugin file name. See `get_plugin_data()`.
    427427 */
    428428function get_dropins() {
     
    472472 *
    473473 * @since 3.0.0
    474  * @return array Key is file name. The value is an array, with the first value the
     474 * @return array[] Key is file name. The value is an array, with the first value the
    475475 *  purpose of the drop-in and the second value the name of the constant that must be
    476476 *  true for the drop-in to be used, or true if no constant is required.
     
    10301030 *
    10311031 * @since 2.5.0
    1032  * @return array invalid plugins, plugin as key, error as value
     1032 * @return WP_Error[] Array of plugin errors keyed by plugin file name.
    10331033 */
    10341034function validate_active_plugins() {
Note: See TracChangeset for help on using the changeset viewer.