Make WordPress Core


Ignore:
Timestamp:
12/09/2015 09:25:15 PM (8 years ago)
Author:
rachelbaker
Message:

Docs: Better param descriptions and fix incorrect param name within REST API deprecated functions

rest_handle_deprecated_function: you get better parameter descriptions.
rest_handle_deprecated_argument: you get a corrected parameter name ($replacement->$message), appropriate i18n translation hints, and better parameter descriptions.

Props ocean90.
Fixes #34908

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/rest-api.php

    r35822 r35845  
    325325 * @since 4.4.0
    326326 *
    327  * @param string $function    Function name.
    328  * @param string $replacement Replacement function name.
     327 * @param string $function    The function that was called.
     328 * @param string $replacement The function that should have been called.
    329329 * @param string $version     Version.
    330330 */
     
    346346 * @since 4.4.0
    347347 *
    348  * @param string $function    Function name.
    349  * @param string $replacement Replacement function name.
     348 * @param string $function    The function that was called.
     349 * @param string $message     A message regarding the change.
    350350 * @param string $version     Version.
    351351 */
    352 function rest_handle_deprecated_argument( $function, $replacement, $version ) {
    353     if ( ! empty( $replacement ) ) {
    354         /* translators: 1: function name, 2: WordPress version number, 3: new argument name */
    355         $string = sprintf( __( '%1$s (since %2$s; %3$s)' ), $function, $version, $replacement );
     352function rest_handle_deprecated_argument( $function, $message, $version ) {
     353    if ( ! empty( $message ) ) {
     354        /* translators: 1: function name, 2: WordPress version number, 3: error message */
     355        $string = sprintf( __( '%1$s (since %2$s; %3$s)' ), $function, $version, $message );
    356356    } else {
    357357        /* translators: 1: function name, 2: WordPress version number */
Note: See TracChangeset for help on using the changeset viewer.