WordPress.org

Make WordPress Core

Changeset 44581


Ignore:
Timestamp:
01/14/2019 06:53:44 AM (3 years ago)
Author:
pento
Message:

Docs: Improve docblocks for _get_plugin_data_markup_translate() and _sort_uname_callback().

Props Jaydeep Rami.
Fixes #42228.

File:
1 edited

Legend:

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

    r44562 r44581  
    115115 *
    116116 * @since 2.7.0
     117 *
     118 * @see get_plugin_data()
     119 *
    117120 * @access private
    118  * @see get_plugin_data()
     121 *
     122 * @param string $plugin_file Path to the main plugin file.
     123 * @param array  $plugin_data An array of plugin data. See `get_plugin_data()`.
     124 * @param bool   $markup      Optional. If the returned data should have HTML markup applied.
     125 *                            Default true.
     126 * @param bool   $translate   Optional. If the returned data should be translated. Default true.
     127 * @return array {
     128 *     Plugin data. Values will be empty if not supplied by the plugin.
     129 *
     130 *     @type string $Name        Name of the plugin. Should be unique.
     131 *     @type string $Title       Title of the plugin and link to the plugin's site (if set).
     132 *     @type string $Description Plugin description.
     133 *     @type string $Author      Author's name.
     134 *     @type string $AuthorURI   Author's website address (if set).
     135 *     @type string $Version     Plugin version.
     136 *     @type string $TextDomain  Plugin textdomain.
     137 *     @type string $DomainPath  Plugins relative directory path to .mo files.
     138 *     @type bool   $Network     Whether the plugin can only be activated network-wide.
     139 * }
    119140 */
    120141function _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup = true, $translate = true ) {
     
    377398 *
    378399 * @since 3.1.0
     400 *
    379401 * @access private
     402 *
     403 * @param array $a array with 'Name' key.
     404 * @param array $b array with 'Name' key.
     405 * @return int Return 0 or 1 based on two string comparison.
    380406 */
    381407function _sort_uname_callback( $a, $b ) {
Note: See TracChangeset for help on using the changeset viewer.