WordPress.org
Get WordPress

Make WordPress Core

Changeset 30656


Ignore:
Timestamp:
11/30/2014 12:09:56 PM (12 years ago)
Author:
DrewAPicture
Message:

Docs Formatting: Backtick-escape inline code for all remaining dynamic hook docs in wp-includes/*.

Affects DocBlocks for the following hooks:

  • auth_post_meta_{$meta_key}
  • term_links-$taxonomy
  • customize_render_control_ . $this->id
  • customize_render_panel_{$this->id}
  • customize_render_section_{$this->id}
  • customize_preview_{$this->id}
  • customize_save_ . $this->id_data[ 'base' ]
  • customize_update_ . $this->type
  • customize_value_ . $this->id_data[ 'base' ]
  • customize_sanitize_js_{$this->id}
  • comment_form_field_{$name}
  • comment_{$old_status}_to_{$new_status}
  • comment_{$new_status}_{$comment->comment_type}
  • extra_{$context}_headers
  • get_template_part_{$slug}
  • get_the_generator_{$type}
  • get_{$adjacent}_post_join
  • get_{$adjacent}_post_where
  • get_{$adjacent}_post_sort
  • {$adjacent}_post_rel_link
  • {$adjacent}_post_link
  • {$adjacent}_image_link
  • blog_option_{$option}
  • $permastructname . _rewrite_rules
  • {$type}_template
  • theme_mod_{$name}
  • pre_set_theme_mod_$name
  • current_theme_supports-{$feature}
  • get_user_option_{$option}
  • edit_user_{$field}
  • pre_user_{$field}
  • user_{$field}

See #30552.

Location:
trunk/src/wp-includes
Files:
17 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/capabilities.php

    r30536 r30656  
    12051205                         * Filter whether the user is allowed to add post meta to a post.
    12061206                         *
    1207                          * The dynamic portion of the hook name, $meta_key, refers to the
    1208                          * meta key passed to map_meta_cap().
     1207                         * The dynamic portion of the hook name, `$meta_key`, refers to the
     1208                         * meta key passed to {@see map_meta_cap()}.
    12091209                         *
    12101210                         * @since 3.3.0

  • trunk/src/wp-includes/category-template.php

    r30105 r30656  
    13001300         * Filter the term links for a given taxonomy.
    13011301         *
    1302          * The dynamic portion of the filter name, $taxonomy, refers
     1302         * The dynamic portion of the filter name, `$taxonomy`, refers
    13031303         * to the taxonomy slug.
    13041304         *

  • trunk/src/wp-includes/class-wp-customize-control.php

    r30605 r30656  
    321321                 * Fires just before a specific Customizer control is rendered.
    322322                 *
    323                  * The dynamic portion of the hook name, $this->id, refers to
     323                 * The dynamic portion of the hook name, `$this->id`, refers to
    324324                 * the control ID.
    325325                 *
    326326                 * @since 3.4.0
    327327                 *
    328                  * @param WP_Customize_Control $this WP_Customize_Control instance.
     328                 * @param WP_Customize_Control $this {@see WP_Customize_Control} instance.
    329329                 */
    330330                do_action( 'customize_render_control_' . $this->id, $this );

  • trunk/src/wp-includes/class-wp-customize-panel.php

    r30607 r30656  
    269269                 * Fires before rendering a specific Customizer panel.
    270270                 *
    271                  * The dynamic portion of the hook name, $this->id, refers to the ID
    272                  * of the specific Customizer panel to be rendered.
     271                 * The dynamic portion of the hook name, `$this->id`, refers to
     272                 * the ID of the specific Customizer panel to be rendered.
    273273                 *
    274274                 * @since 4.0.0

  • trunk/src/wp-includes/class-wp-customize-section.php

    r30608 r30656  
    277277                 * Fires before rendering a specific Customizer section.
    278278                 *
    279                  * The dynamic portion of the hook name, $this->id, refers to the ID
     279                 * The dynamic portion of the hook name, `$this->id`, refers to the ID
    280280                 * of the specific Customizer section to be rendered.
    281281                 *

  • trunk/src/wp-includes/class-wp-customize-setting.php

    r30609 r30656  
    128128                                 * not handled as theme_mods or options.
    129129                                 *
    130                                  * The dynamic portion of the hook name, $this->id, refers to the setting ID.
     130                                 * The dynamic portion of the hook name, `$this->id`, refers to the setting ID.
    131131                                 *
    132132                                 * @since 3.4.0
    133133                                 *
    134                                  * @param WP_Customize_Setting $this WP_Customize_Setting instance.
     134                                 * @param WP_Customize_Setting $this {@see WP_Customize_Setting} instance.
    135135                                 */
    136136                                do_action( "customize_preview_{$this->id}", $this );
    … …  
    180180                 * Fires when the WP_Customize_Setting::save() method is called.
    181181                 *
    182                  * The dynamic portion of the hook name, $this->id_data['base'] refers to
     182                 * The dynamic portion of the hook name, `$this->id_data['base']` refers to
    183183                 * the base slug of the setting name.
    184184                 *
    185185                 * @since 3.4.0
    186186                 *
    187                  * @param WP_Customize_Setting $this WP_Customize_Setting instance.
     187                 * @param WP_Customize_Setting $this {@see WP_Customize_Setting} instance.
    188188                 */
    189189                do_action( 'customize_save_' . $this->id_data[ 'base' ], $this );
    … …  
    255255
    256256                                /**
    257                                  * Fires when the WP_Customize_Setting::update() method is called for settings
     257                                 * Fires when the {@see WP_Customize_Setting::update()} method is called for settings
    258258                                 * not handled as theme_mods or options.
    259259                                 *
    260                                  * The dynamic portion of the hook name, $this->type, refers to the type of setting.
     260                                 * The dynamic portion of the hook name, `$this->type`, refers to the type of setting.
    261261                                 *
    262262                                 * @since 3.4.0
    … …  
    330330                                 * Filter a Customize setting value not handled as a theme_mod or option.
    331331                                 *
    332                                  * The dynamic portion of the hook name, $this->id_date['base'], refers to
     332                                 * The dynamic portion of the hook name, `$this->id_date['base']`, refers to
    333333                                 * the base slug of the setting name.
    334334                                 *
    … …  
    364364                 * Filter a Customize setting value for use in JavaScript.
    365365                 *
    366                  * The dynamic portion of the hook name, $this->id, refers to the setting ID.
     366                 * The dynamic portion of the hook name, `$this->id`, refers to the setting ID.
    367367                 *
    368368                 * @since 3.4.0
    369369                 *
    370370                 * @param mixed                $value The setting value.
    371                  * @param WP_Customize_Setting $this  WP_Customize_Setting instance.
     371                 * @param WP_Customize_Setting $this  {@see WP_Customize_Setting} instance.
    372372                 */
    373373                $value = apply_filters( "customize_sanitize_js_{$this->id}", $this->value(), $this );

  • trunk/src/wp-includes/comment-template.php

    r30610 r30656  
    23022302                                                                 * Filter a comment form field for display.
    23032303                                                                 *
    2304                                                                  * The dynamic portion of the filter hook, $name, refers to the name
     2304                                                                 * The dynamic portion of the filter hook, `$name`, refers to the name
    23052305                                                                 * of the comment form field. Such as 'author', 'email', or 'url'.
    23062306                                                                 *

  • trunk/src/wp-includes/comment.php

    r30579 r30656  
    18191819                 * Fires when the comment status is in transition from one specific status to another.
    18201820                 *
    1821                  * The dynamic portions of the hook name, $old_status, and $new_status,
     1821                 * The dynamic portions of the hook name, `$old_status`, and `$new_status`,
    18221822                 * refer to the old and new comment statuses, respectively.
    18231823                 *
    … …  
    18311831         * Fires when the status of a specific comment type is in transition.
    18321832         *
    1833          * The dynamic portions of the hook name, $new_status, and $comment->comment_type,
     1833         * The dynamic portions of the hook name, `$new_status`, and `$comment->comment_type`,
    18341834         * refer to the new comment status, and the type of comment, respectively.
    18351835         *

  • trunk/src/wp-includes/functions.php

    r30640 r30656  
    41954195         * Filter extra file headers by context.
    41964196         *
    4197          * The dynamic portion of the hook name, $context, refers to the context
    4198          * where extra headers might be loaded.
     4197         * The dynamic portion of the hook name, `$context`, refers to
     4198         * the context where extra headers might be loaded.
    41994199         *
    42004200         * @since 2.9.0

  • trunk/src/wp-includes/general-template.php

    r30615 r30656  
    152152         * Fires before the specified template part file is loaded.
    153153         *
    154          * The dynamic portion of the hook name, $slug, refers to the slug name
     154         * The dynamic portion of the hook name, `$slug`, refers to the slug name
    155155         * for the generic template part.
    156156         *
    … …  
    30103010         * Filter the HTML for the retrieved generator type.
    30113011         *
    3012          * The dynamic portion of the hook name, $type, refers to the generator type.
     3012         * The dynamic portion of the hook name, `$type`, refers to the generator type.
    30133013         *
    30143014         * @since 2.5.0
    30153015         *
    3016          * @param string $gen  The HTML markup output to 'wp_head()'.
     3016         * @param string $gen  The HTML markup output to {@see wp_head()}.
    30173017         * @param string $type The type of generator. Accepts 'html', 'xhtml', 'atom',
    30183018         *                     'rss2', 'rdf', 'comment', 'export'.

  • trunk/src/wp-includes/link-template.php

    r30628 r30656  
    15251525         * Filter the JOIN clause in the SQL for an adjacent post query.
    15261526         *
    1527          * The dynamic portion of the hook name, $adjacent, refers to the type
     1527         * The dynamic portion of the hook name, `$adjacent`, refers to the type
    15281528         * of adjacency, 'next' or 'previous'.
    15291529         *
    … …  
    15391539         * Filter the WHERE clause in the SQL for an adjacent post query.
    15401540         *
    1541          * The dynamic portion of the hook name, $adjacent, refers to the type
     1541         * The dynamic portion of the hook name, `$adjacent`, refers to the type
    15421542         * of adjacency, 'next' or 'previous'.
    15431543         *
    15441544         * @since 2.5.0
    15451545         *
    1546          * @param string $where          The WHERE clause in the SQL.
     1546         * @param string $where          The `WHERE` clause in the SQL.
    15471547         * @param bool   $in_same_term   Whether post should be in a same taxonomy term.
    15481548         * @param array  $excluded_terms Array of excluded term IDs.
    … …  
    15531553         * Filter the ORDER BY clause in the SQL for an adjacent post query.
    15541554         *
    1555          * The dynamic portion of the hook name, $adjacent, refers to the type
     1555         * The dynamic portion of the hook name, `$adjacent`, refers to the type
    15561556         * of adjacency, 'next' or 'previous'.
    15571557         *
    15581558         * @since 2.5.0
    15591559         *
    1560          * @param string $order_by The ORDER BY clause in the SQL.
     1560         * @param string $order_by The `ORDER BY` clause in the SQL.
    15611561         */
    15621562        $sort  = apply_filters( "get_{$adjacent}_post_sort", "ORDER BY p.post_date $order LIMIT 1" );
    … …  
    16251625         * Filter the adjacent post relational link.
    16261626         *
    1627          * The dynamic portion of the hook name, $adjacent, refers to the type
     1627         * The dynamic portion of the hook name, `$adjacent`, refers to the type
    16281628         * of adjacency, 'next' or 'previous'.
    16291629         *
    … …  
    18621862         * Filter the adjacent post link.
    18631863         *
    1864          * The dynamic portion of the hook name, $adjacent, refers to the type
     1864         * The dynamic portion of the hook name, `$adjacent`, refers to the type
    18651865         * of adjacency, 'next' or 'previous'.
    18661866         *

  • trunk/src/wp-includes/media.php

    r30646 r30656  
    19431943         * Filter the adjacent image link.
    19441944         *
    1945          * The dynamic portion of the hook name, $adjacent, refers to the type of adjacency,
     1945         * The dynamic portion of the hook name, `$adjacent`, refers to the type of adjacency,
    19461946         * either 'next', or 'previous'.
    19471947         *

  • trunk/src/wp-includes/ms-blogs.php

    r29668 r30656  
    461461         * Filter a blog option value.
    462462         *
    463          * The dynamic portion of the hook name, $option, refers to the blog option name.
     463         * The dynamic portion of the hook name, `$option`, refers to the blog option name.
    464464         *
    465465         * @since 3.5.0

  • trunk/src/wp-includes/rewrite.php

    r30545 r30656  
    16771677                         * Filter rewrite rules used for individual permastructs.
    16781678                         *
    1679                          * The dynamic portion of the hook name, $permastructname, refers
     1679                         * The dynamic portion of the hook name, `$permastructname`, refers
    16801680                         * to the name of the registered permastruct, e.g. 'post_tag' (tags),
    16811681                         * 'category' (categories), etc.

  • trunk/src/wp-includes/template.php

    r29044 r30656  
    3131         * Filter the path of the queried template by type.
    3232         *
    33          * The dynamic portion of the hook name, $type, refers to the filename
     33         * The dynamic portion of the hook name, `$type`, refers to the filename
    3434         * -- minus the extension -- of the file to load. This hook also applies
    3535         * to various types of files loaded as part of the Template Hierarchy.
    … …  
    3737         * @since 1.5.0
    3838         *
    39          * @param string $template Path to the template. @see locate_template()
     39         * @param string $template Path to the template. See {@see locate_template()}.
    4040         */
    4141        return apply_filters( "{$type}_template", $template );

  • trunk/src/wp-includes/theme.php

    r30189 r30656  
    910910                 * Filter the theme modification, or 'theme_mod', value.
    911911                 *
    912                  * The dynamic portion of the hook name, $name, refers to
     912                 * The dynamic portion of the hook name, `$name`, refers to
    913913                 * the key name of the modification array. For example,
    914914                 * 'header_textcolor', 'header_image', and so on depending
    … …  
    944944         * Filter the theme mod value on save.
    945945         *
    946          * The dynamic portion of the hook name, $name, refers to the key name of
     946         * The dynamic portion of the hook name, `$name`, refers to the key name of
    947947         * the modification array. For example, 'header_textcolor', 'header_image',
    948948         * and so on depending on the theme options.
    … …  
    18171817         * Filter whether the current theme supports a specific feature.
    18181818         *
    1819          * The dynamic portion of the hook name, $feature, refers to
    1820          * the specific theme feature. Possible values include 'post-formats',
    1821          * 'post-thumbnails', 'custom-background', 'custom-header', 'menus',
    1822          * 'automatic-feed-links', and 'html5'.
     1819         * The dynamic portion of the hook name, `$feature`, refers to the specific theme
     1820         * feature. Possible values include 'post-formats', 'post-thumbnails', 'custom-background',
     1821         * 'custom-header', 'menus', 'automatic-feed-links', and 'html5'.
    18231822         *
    18241823         * @since 3.4.0

  • trunk/src/wp-includes/user.php

    r30623 r30656  
    372372         * Filter a specific user option value.
    373373         *
    374          * The dynamic portion of the hook name, $option, refers to the user option name.
     374         * The dynamic portion of the hook name, `$option`, refers to the user option name.
    375375         *
    376376         * @since 2.5.0
    … …  
    15001500                         * Filter a user field value in the 'edit' context.
    15011501                         *
    1502                          * The dynamic portion of the hook name, $field, refers to the prefixed user
     1502                         * The dynamic portion of the hook name, `$field`, refers to the prefixed user
    15031503                         * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
    15041504                         *
    … …  
    15241524                         * Filter the value of a user field in the 'db' context.
    15251525                         *
    1526                          * The dynamic portion of the hook name, $field, refers to the prefixed user
     1526                         * The dynamic portion of the hook name, `$field`, refers to the prefixed user
    15271527                         * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
    15281528                         *
    … …  
    15441544                         * Filter the value of a user field in a standard context.
    15451545                         *
    1546                          * The dynamic portion of the hook name, $field, refers to the prefixed user
     1546                         * The dynamic portion of the hook name, `$field`, refers to the prefixed user
    15471547                         * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
    15481548                         *
Note: See TracChangeset for help on using the changeset viewer.