Making WordPress.org

Changeset 1023


Ignore:
Timestamp:
12/03/2014 07:29:57 PM (10 years ago)
Author:
coffee2code
Message:

developer.wordpress.org: ensure a parameter is set as optional if it has a default value explicitly defined

Some @param docs don't explicitly indicate when a parameter is optional, so infer it from a default value being defined in the method signature.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/template-tags.php

    r1022 r1023  
    607607                    $params[ $arg['name'] ]['default'] = $arg['default'];
    608608
    609                     // If a known default is stated in the parameter's description, try to remove it
    610                     // since the actual default value is displayed immediately following description.
     609                    // If a default value was supplied
    611610                    if ( ! empty( $arg['default'] ) ) {
     611                        // Ensure the parameter was marked as optional (sometimes they aren't
     612                        // properly and explicitly documented as such)
     613                        $params[ $arg['name'] ]['required'] = 'Optional';
     614
     615                        // If a known default is stated in the parameter's description, try to remove it
     616                        // since the actual default value is displayed immediately following description.
    612617                        $default = htmlentities( $arg['default'] );
    613618                        $params[ $arg['name'] ]['content'] = str_replace( "default is {$default}.", '', $params[ $arg['name'] ]['content'] );
Note: See TracChangeset for help on using the changeset viewer.