Make WordPress Core

Ticket #30552: 30552.diff

File 30552.diff, 67.4 KB (added by DrewAPicture, 10 years ago)

Dynamic hook docs

  • src/wp-admin/admin-ajax.php

     
    7777        /**
    7878         * Fires authenticated AJAX actions for logged-in users.
    7979         *
    80          * The dynamic portion of the hook name, $_REQUEST['action'],
     80         * The dynamic portion of the hook name, `$_REQUEST['action']`,
    8181         * refers to the name of the AJAX action callback being fired.
    8282         *
    8383         * @since 2.1.0
     
    8787        /**
    8888         * Fires non-authenticated AJAX actions for logged-out users.
    8989         *
    90          * The dynamic portion of the hook name, $_REQUEST['action'],
     90         * The dynamic portion of the hook name, `$_REQUEST['action']`,
    9191         * refers to the name of the AJAX action callback being fired.
    9292         *
    9393         * @since 2.8.0
  • src/wp-admin/admin-footer.php

     
    7676/**
    7777 * Print scripts or data after the default footer scripts.
    7878 *
    79  * The dynamic portion of the hook name, $GLOBALS['hook_suffix'],
     79 * The dynamic portion of the hook name, `$GLOBALS['hook_suffix']`,
    8080 * refers to the global hook suffix of the current page.
    8181 *
    8282 * @since 2.8.0
  • src/wp-admin/admin-post.php

     
    4242                /**
    4343                 * Fires on a non-authenticated admin post request for the given action.
    4444                 *
    45                  * The dynamic portion of the hook name, $action, refers to the given
     45                 * The dynamic portion of the hook name, `$action`, refers to the given
    4646                 * request action.
    4747                 *
    4848                 * @since 2.6.0
     
    6161                /**
    6262                 * Fires on an authenticated admin post request for the given action.
    6363                 *
    64                  * The dynamic portion of the hook name, $action, refers to the given
     64                 * The dynamic portion of the hook name, `$action`, refers to the given
    6565                 * request action.
    6666                 *
    6767                 * @since 2.6.0
  • src/wp-admin/admin.php

     
    185185                 * The load-* hook fires in a number of contexts. This hook is for plugin screens
    186186                 * where a callback is provided when the screen is registered.
    187187                 *
    188                  * The dynamic portion of the hook name, $page_hook, refers to a mixture of plugin
     188                 * The dynamic portion of the hook name, `$page_hook`, refers to a mixture of plugin
    189189                 * page information including:
    190190                 * 1. The page type. If the plugin page is registered as a submenu page, such as for
    191191                 *    Settings, the page type would be 'settings'. Otherwise the type is 'toplevel'.
    192192                 * 2. A separator of '_page_'.
    193193                 * 3. The plugin basename minus the file extension.
    194194                 *
    195                  * Together, the three parts form the $page_hook. Citing the example above,
     195                 * Together, the three parts form the `$page_hook`. Citing the example above,
    196196                 * the hook name used would be 'load-settings_page_pluginbasename'.
    197197                 *
    198198                 * @see get_plugin_page_hook()
     
    223223                 * The load-* hook fires in a number of contexts. This hook is for plugin screens
    224224                 * where the file to load is directly included, rather than the use of a function.
    225225                 *
    226                  * The dynamic portion of the hook name, $plugin_page, refers to the plugin basename.
     226                 * The dynamic portion of the hook name, `$plugin_page`, refers to the plugin basename.
    227227                 *
    228228                 * @see plugin_basename()
    229229                 *
     
    263263        /**
    264264         * Fires before an importer screen is loaded.
    265265         *
    266          * The dynamic portion of the hook name, $importer, refers to the importer slug.
     266         * The dynamic portion of the hook name, `$importer`, refers to the importer slug.
    267267         *
    268268         * @since 3.5.0
    269269         */
     
    308308         *
    309309         * The load-* hook fires in a number of contexts. This hook is for core screens.
    310310         *
    311          * The dynamic portion of the hook name, $pagenow, is a global variable
     311         * The dynamic portion of the hook name, `$pagenow`, is a global variable
    312312         * referring to the filename of the current page, such as 'admin.php',
    313313         * 'post-new.php' etc. A complete hook for the latter would be
    314314         * 'load-post-new.php'.
     
    338338        /**
    339339         * Fires when an 'action' request variable is sent.
    340340         *
    341          * The dynamic portion of the hook name, $_REQUEST['action'],
    342          * refers to the action derived from the GET or POST request.
     341         * The dynamic portion of the hook name, `$_REQUEST['action']`,
     342         * refers to the action derived from the `GET` or `POST` request.
    343343         *
    344344         * @since 2.6.0
    345345         */
  • src/wp-admin/async-upload.php

     
    104104        /**
    105105         * Filter the returned ID of an uploaded attachment.
    106106         *
    107          * The dynamic portion of the hook name, $type, refers to the attachment type,
     107         * The dynamic portion of the hook name, `$type`, refers to the attachment type,
    108108         * such as 'image', 'audio', 'video', 'file', etc.
    109109         *
    110110         * @since 2.5.0
  • src/wp-admin/edit-form-advanced.php

     
    244244/**
    245245 * Fires after all built-in meta boxes have been added, contextually for the given post type.
    246246 *
    247  * The dynamic portion of the hook, $post_type, refers to the post type of the post.
     247 * The dynamic portion of the hook, `$post_type`, refers to the post type of the post.
    248248 *
    249249 * @since 3.0.0
    250250 *
  • src/wp-admin/edit-tag-form.php

     
    5151/**
    5252 * Fires before the Edit Term form for all taxonomies.
    5353 *
    54  * The dynamic portion of the hook name, $taxonomy, refers to
     54 * The dynamic portion of the hook name, `$taxonomy`, refers to
    5555 * the taxonomy slug.
    5656 *
    5757 * @since 3.0.0
     
    6868/**
    6969 * Fires inside the Edit Term form tag.
    7070 *
    71  * The dynamic portion of the hook name, $taxonomy, refers to
     71 * The dynamic portion of the hook name, `$taxonomy`, refers to
    7272 * the taxonomy slug.
    7373 *
    7474 * @since 3.7.0
     
    153153                /**
    154154                 * Fires after the Edit Term form fields are displayed.
    155155                 *
    156                  * The dynamic portion of the hook name, $taxonomy, refers to
     156                 * The dynamic portion of the hook name, `$taxonomy`, refers to
    157157                 * the taxonomy slug.
    158158                 *
    159159                 * @since 3.0.0
     
    186186/**
    187187 * Fires at the end of the Edit Term form for all taxonomies.
    188188 *
    189  * The dynamic portion of the hook name, $taxonomy, refers to the taxonomy slug.
     189 * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
    190190 *
    191191 * @since 3.0.0
    192192 *
  • src/wp-admin/edit-tags.php

     
    351351/**
    352352 * Fires after the taxonomy list table.
    353353 *
    354  * The dynamic portion of the hook name, $taxonomy, refers to the taxonomy slug.
     354 * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
    355355 *
    356356 * @since 3.0.0
    357357 *
     
    420420        /**
    421421         * Fires before the Add Term form for all taxonomies.
    422422         *
    423          * The dynamic portion of the hook name, $taxonomy, refers to the taxonomy slug.
     423         * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
    424424         *
    425425         * @since 3.0.0
    426426         *
     
    435435/**
    436436 * Fires at the beginning of the Add Tag form.
    437437 *
    438  * The dynamic portion of the hook name, $taxonomy, refers to the taxonomy slug.
     438 * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
    439439 *
    440440 * @since 3.7.0
    441441 */
     
    521521/**
    522522 * Fires after the Add Term form fields for hierarchical taxonomies.
    523523 *
    524  * The dynamic portion of the hook name, $taxonomy, refers to the taxonomy slug.
     524 * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
    525525 *
    526526 * @since 3.0.0
    527527 *
     
    566566/**
    567567 * Fires at the end of the Add Term form for all taxonomies.
    568568 *
    569  * The dynamic portion of the hook name, $taxonomy, refers to the taxonomy slug.
     569 * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
    570570 *
    571571 * @since 3.0.0
    572572 *
  • src/wp-admin/includes/class-wp-list-table.php

     
    342342                /**
    343343                 * Filter the list of available list table views.
    344344                 *
    345                  * The dynamic portion of the hook name, $this->screen->id, refers
     345                 * The dynamic portion of the hook name, `$this->screen->id`, refers
    346346                 * to the ID of the current screen, usually a string.
    347347                 *
    348348                 * @since 3.5.0
     
    390390                        /**
    391391                         * Filter the list table Bulk Actions drop-down.
    392392                         *
    393                          * The dynamic portion of the hook name, $this->screen->id, refers
     393                         * The dynamic portion of the hook name, `$this->screen->id`, refers
    394394                         * to the ID of the current screen, usually a string.
    395395                         *
    396396                         * This filter can currently only be used to remove bulk actions.
     
    766766                /**
    767767                 * Filter the list table sortable columns for a specific screen.
    768768                 *
    769                  * The dynamic portion of the hook name, $this->screen->id, refers
     769                 * The dynamic portion of the hook name, `$this->screen->id`, refers
    770770                 * to the ID of the current screen, usually a string.
    771771                 *
    772772                 * @since 3.5.0
  • src/wp-admin/includes/class-wp-ms-themes-list-table.php

     
    331331                 * Filter the action links of a specific theme in the Multisite themes
    332332                 * list table.
    333333                 *
    334                  * The dynamic portion of the hook name, $stylesheet, refers to the
     334                 * The dynamic portion of the hook name, `$stylesheet`, refers to the
    335335                 * directory name of the theme, which in most cases is synonymous
    336336                 * with the template name.
    337337                 *
     
    444444                /**
    445445                 * Fires after each specific row in the Multisite themes list table.
    446446                 *
    447                  * The dynamic portion of the hook name, $stylesheet, refers to the
     447                 * The dynamic portion of the hook name, `$stylesheet`, refers to the
    448448                 * directory name of the theme, most often synonymous with the template
    449449                 * name of the theme.
    450450                 *
  • src/wp-admin/includes/class-wp-plugin-install-list-table.php

     
    156156                /**
    157157                 * Filter API request arguments for each Plugin Install screen tab.
    158158                 *
    159                  * The dynamic portion of the hook name, $tab, refers to the plugin install tabs.
     159                 * The dynamic portion of the hook name, `$tab`, refers to the plugin install tabs.
    160160                 * Default tabs are 'dashboard', 'search', 'upload', 'featured', 'popular', 'new',
    161161                 * and 'favorites'.
    162162                 *
  • src/wp-admin/includes/class-wp-plugins-list-table.php

     
    424424                /**
    425425                 * Filter the action links displayed for each plugin in the Plugins list table.
    426426                 *
    427                  * The dynamic portion of the hook name, $prefix, refers to the context the
     427                 * The dynamic portion of the hook name, `$prefix`, refers to the context the
    428428                 * action links are displayed in. The 'network_admin_' prefix is used if the
    429429                 * current screen is the Network plugins list table. The prefix is empty ('')
    430430                 * if the current screen is the site plugins list table.
     
    589589                /**
    590590                 * Fires after each specific row in the Plugins list table.
    591591                 *
    592                  * The dynamic portion of the hook name, $plugin_file, refers to the path
     592                 * The dynamic portion of the hook name, `$plugin_file`, refers to the path
    593593                 * to the plugin file, relative to the plugins directory.
    594594                 *
    595595                 * @since 2.7.0
  • src/wp-admin/includes/class-wp-posts-list-table.php

     
    301301                /**
    302302                 * Filter the taxonomy columns in the Posts list table.
    303303                 *
    304                  * The dynamic portion of the hook name, $post_type, refers to the post
     304                 * The dynamic portion of the hook name, `$post_type`, refers to the post
    305305                 * type slug.
    306306                 *
    307307                 * @since 3.5.0
     
    355355                /**
    356356                 * Filter the columns displayed in the Posts list table for a specific post type.
    357357                 *
    358                  * The dynamic portion of the hook name, $post_type, refers to the post type slug.
     358                 * The dynamic portion of the hook name, `$post_type`, refers to the post type slug.
    359359                 *
    360360                 * @since 3.0.0
    361361                 *
     
    877877                                /**
    878878                                 * Fires for each custom column of a specific post type in the Posts list table.
    879879                                 *
    880                                  * The dynamic portion of the hook name, $post->post_type, refers to the post type.
     880                                 * The dynamic portion of the hook name, `$post->post_type`, refers to the post type.
    881881                                 *
    882882                                 * @since 3.1.0
    883883                                 *
  • src/wp-admin/includes/class-wp-terms-list-table.php

     
    327327                /**
    328328                 * Filter the action links displayed for each term in the terms list table.
    329329                 *
    330                  * The dynamic portion of the hook name, $taxonomy, refers to the taxonomy slug.
     330                 * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
    331331                 *
    332332                 * @since 3.0.0
    333333                 *
     
    392392                /**
    393393                 * Filter the displayed columns in the terms list table.
    394394                 *
    395                  * The dynamic portion of the hook name, $this->screen->taxonomy,
     395                 * The dynamic portion of the hook name, `$this->screen->taxonomy`,
    396396                 * refers to the slug of the current taxonomy.
    397397                 *
    398398                 * @since 2.8.0
  • src/wp-admin/includes/class-wp-theme-install-list-table.php

     
    106106                /**
    107107                 * Filter API request arguments for each Install Themes screen tab.
    108108                 *
    109                  * The dynamic portion of the hook name, $tab, refers to the theme install
     109                 * The dynamic portion of the hook name, `$tab`, refers to the theme install
    110110                 * tabs. Default tabs are 'dashboard', 'search', 'upload', 'featured',
    111111                 * 'new', and 'updated'.
    112112                 *
  • src/wp-admin/includes/class-wp-upgrader.php

     
    19341934                /**
    19351935                 * Filter whether to automatically update core, a plugin, a theme, or a language.
    19361936                 *
    1937                  * The dynamic portion of the hook name, $type, refers to the type of update
     1937                 * The dynamic portion of the hook name, `$type`, refers to the type of update
    19381938                 * being checked. Can be 'core', 'theme', 'plugin', or 'translation'.
    19391939                 *
    19401940                 * Generally speaking, plugins, themes, and major core versions are not updated
    19411941                 * by default, while translations and minor and development versions for core
    19421942                 * are updated by default.
    19431943                 *
    1944                  * See the allow_dev_auto_core_updates, allow_minor_auto_core_updates, and
    1945                  * allow_major_auto_core_updates filters for a more straightforward way to
     1944                 * See the {@see 'allow_dev_auto_core_updates', {@see 'allow_minor_auto_core_updates'},
     1945                 * and {@see 'allow_major_auto_core_updates'} filters for a more straightforward way to
    19461946                 * adjust core updates.
    19471947                 *
    19481948                 * @since 3.7.0
  • src/wp-admin/includes/file.php

     
    208208        }
    209209
    210210        /**
    211          * The dynamic portion of the hook name, $action, refers to the post action.
     211         * Filter the data for a file before it is uploaded to WordPress.
    212212         *
    213          * @since 2.9.0 as 'wp_handle_upload_prefilter'
    214          * @since 4.0.0 Converted to a dynamic hook with $action
     213         * The dynamic portion of the hook name, `$action`, refers to the post action.
    215214         *
     215         * @since 2.9.0 as 'wp_handle_upload_prefilter'.
     216         * @since 4.0.0 Converted to a dynamic hook with `$action`.
     217         *
    216218         * @param array $file An array of data for a single file.
    217219         */
    218220        $file = apply_filters( "{$action}_prefilter", $file );
  • src/wp-admin/includes/media.php

     
    494494         * Fires in the admin header for each specific form tab in the legacy
    495495         * (pre-3.5.0) media upload popup.
    496496         *
    497          * The dynamic portion of the hook, $content_func, refers to the form
     497         * The dynamic portion of the hook, `$content_func`, refers to the form
    498498         * callback for the media upload type. Possible values include
    499499         * 'media_upload_type_form', 'media_upload_type_url_form', and
    500500         * 'media_upload_library_form'.
     
    595595        /**
    596596         * Filter the upload iframe source URL for a specific media type.
    597597         *
    598          * The dynamic portion of the hook name, $type, refers to the type
     598         * The dynamic portion of the hook name, `$type`, refers to the type
    599599         * of media uploaded.
    600600         *
    601601         * @since 3.0.0
     
    763763                        /**
    764764                         * Filter the URL sent to the editor for a specific media type.
    765765                         *
    766                          * The dynamic portion of the hook name, $type, refers to the type
     766                         * The dynamic portion of the hook name, `$type`, refers to the type
    767767                         * of media being sent.
    768768                         *
    769769                         * @since 3.3.0
  • src/wp-admin/includes/nav-menu.php

     
    792792                                 * Filter the posts displayed in the 'View All' tab of the current
    793793                                 * post type's menu items meta box.
    794794                                 *
    795                                  * The dynamic portion of the hook name, $post_type_name,
    796                                  * refers to the slug of the current post type.
     795                                 * The dynamic portion of the hook name, `$post_type_name`, refers
     796                                 * to the slug of the current post type.
    797797                                 *
    798798                                 * @since 3.2.0
    799799                                 *
  • src/wp-admin/includes/plugin.php

     
    561561                         * Fires as a specific plugin is being activated.
    562562                         *
    563563                         * This hook is the "activation" hook used internally by
    564                          * register_activation_hook(). The dynamic portion of the
    565                          * hook name, $plugin, refers to the plugin basename.
     564                         * {@see register_activation_hook()}. The dynamic portion of the
     565                         * hook name, `$plugin`, refers to the plugin basename.
    566566                         *
    567567                         * If a plugin is silently activated (such as during an update),
    568568                         * this hook does not fire.
     
    674674                         * Fires as a specific plugin is being deactivated.
    675675                         *
    676676                         * This hook is the "deactivation" hook used internally by
    677                          * register_deactivation_hook(). The dynamic portion of the
    678                          * hook name, $plugin, refers to the plugin basename.
     677                         * {@see register_deactivation_hook()}. The dynamic portion of the
     678                         * hook name, `$plugin`, refers to the plugin basename.
    679679                         *
    680680                         * If a plugin is silently deactivated (such as during an update),
    681681                         * this hook does not fire.
  • src/wp-admin/includes/post.php

     
    965965        /**
    966966         * Filter the number of items per page to show for a specific 'per_page' type.
    967967         *
    968          * The dynamic portion of the hook name, $post_type, refers to the post type.
     968         * The dynamic portion of the hook name, `$post_type`, refers to the post type.
    969969         *
    970970         * Some examples of filter hooks generated here include: 'edit_attachment_per_page',
    971971         * 'edit_post_per_page', 'edit_page_per_page', etc.
     
    11041104        /**
    11051105         * Filter the postbox classes for a specific screen and screen ID combo.
    11061106         *
    1107          * The dynamic portions of the hook name, $page, and $id, refer to
     1107         * The dynamic portions of the hook name, `$page`, and `$id`, refer to
    11081108         * the screen, and screen ID, respectively.
    11091109         *
    11101110         * @since 3.2.0
  • src/wp-admin/includes/revision.php

     
    5858                /**
    5959                 * Contextually filter a post revision field.
    6060                 *
    61                  * The dynamic portion of the hook name, $field, corresponds to each of the post
     61                 * The dynamic portion of the hook name, `$field`, corresponds to each of the post
    6262                 * fields of the revision object being iterated over in a foreach statement.
    6363                 *
    6464                 * @since 3.6.0
     
    6666                 * @param string  $compare_from->$field The current revision field to compare to or from.
    6767                 * @param string  $field                The current revision field.
    6868                 * @param WP_Post $compare_from         The revision post object to compare to or from.
    69                  * @param string  null                  The context of whether the current revision is the old or the new one. Values are 'to' or 'from'.
     69                 * @param string  null                  The context of whether the current revision is the old
     70                 *                                      or the new one. Values are 'to' or 'from'.
    7071                 */
    7172                $content_from = $compare_from ? apply_filters( "_wp_post_revision_field_$field", $compare_from->$field, $field, $compare_from, 'from' ) : '';
    7273
  • src/wp-admin/includes/screen.php

     
    2525                /**
    2626                 * Filter the column headers for a list table on a specific screen.
    2727                 *
    28                  * The dynamic portion of the hook name, $screen->id, refers to the
     28                 * The dynamic portion of the hook name, `$screen->id`, refers to the
    2929                 * ID of a specific screen. For example, the screen ID for the Posts
    3030                 * list table is edit-post, so the filter for that screen would be
    3131                 * manage_edit-post_columns.
  • src/wp-admin/includes/update.php

     
    289289                 * Fires at the end of the update message container in each
    290290                 * row of the plugins list table.
    291291                 *
    292                  * The dynamic portion of the hook name, $file, refers to the path
     292                 * The dynamic portion of the hook name, `$file`, refers to the path
    293293                 * of the plugin's primary file relative to the plugins directory.
    294294                 *
    295295                 * @since 2.8.0
     
    378378         * Fires at the end of the update message container in each
    379379         * row of the themes list table.
    380380         *
    381          * The dynamic portion of the hook name, $theme_key, refers to
     381         * The dynamic portion of the hook name, `$theme_key`, refers to
    382382         * the theme slug as found in the WordPress.org themes repository.
    383383         *
    384384         * @since 3.1.0
  • src/wp-admin/media-upload.php

     
    7474                 * Fires inside specific upload-type views in the legacy (pre-3.5.0)
    7575                 * media popup based on the current tab.
    7676                 *
    77                  * The dynamic portion of the hook name, $type, refers to the specific
     77                 * The dynamic portion of the hook name, `$type`, refers to the specific
    7878                 * media upload type. Possible values include 'image', 'audio', 'video',
    7979                 * 'file', etc.
    8080                 *
    81                  * The hook only fires if the current $tab is 'type' (From Computer),
     81                 * The hook only fires if the current `$tab` is 'type' (From Computer),
    8282                 * 'type_url' (From URL), or, if the tab does not exist (i.e., has not
    83                  * been registered via the 'media_upload_tabs' filter.
     83                 * been registered via the {@see 'media_upload_tabs'} filter.
    8484                 *
    8585                 * @since 2.5.0
    8686                 */
     
    9090                 * Fires inside limited and specific upload-tab views in the legacy
    9191                 * (pre-3.5.0) media popup.
    9292                 *
    93                  * The dynamic portion of the hook name, $tab, refers to the specific
     93                 * The dynamic portion of the hook name, `$tab`, refers to the specific
    9494                 * media upload tab. Possible values include 'library' (Media Library),
    95                  * or any custom tab registered via the 'media_upload_tabs' filter.
     95                 * or any custom tab registered via the {@see 'media_upload_tabs'} filter.
    9696                 *
    9797                 * @since 2.5.0
    9898                 */
  • src/wp-admin/network/edit.php

     
    3131/**
    3232 * Fires the requested handler action.
    3333 *
    34  * The dynamic portion of the hook name, $_GET['action'], refers to the name
     34 * The dynamic portion of the hook name, `$_GET['action']`, refers to the name
    3535 * of the requested action.
    3636 *
    3737 * @since 3.1.0
  • src/wp-admin/network/sites.php

     
    227227                        /**
    228228                         * Filter a specific, non-default site-updated message in the Network admin.
    229229                         *
    230                          * The dynamic portion of the hook name, $_GET['updated'], refers to the non-default
    231                          * site update action.
     230                         * The dynamic portion of the hook name, `$_GET['updated']`, refers to the
     231                         * non-default site update action.
    232232                         *
    233233                         * @since 3.1.0
    234234                         *
  • src/wp-admin/plugin-install.php

     
    5757/**
    5858 * Fires before each tab on the Install Plugins screen is loaded.
    5959 *
    60  * The dynamic portion of the action hook, $tab, allows for targeting
     60 * The dynamic portion of the action hook, `$tab`, allows for targeting
    6161 * individual tabs, for instance 'install_plugins_pre_plugin-information'.
    6262 *
    6363 * @since 2.7.0
     
    117117/**
    118118 * Fires after the plugins list table in each tab of the Install Plugins screen.
    119119 *
    120  * The dynamic portion of the action hook, $tab, allows for targeting
     120 * The dynamic portion of the action hook, `$tab`, allows for targeting
    121121 * individual tabs, for instance 'install_plugins_plugin-information'.
    122122 *
    123123 * @since 2.7.0
  • src/wp-admin/theme-install.php

     
    5858/**
    5959 * Fires before each of the tabs are rendered on the Install Themes page.
    6060 *
    61  * The dynamic portion of the hook name, $tab, refers to the current
     61 * The dynamic portion of the hook name, `$tab`, refers to the current
    6262 * theme install tab. Possible values are 'dashboard', 'search', 'upload',
    6363 * 'featured', 'new', or 'updated'.
    6464 *
     
    180180/**
    181181 * Fires at the top of each of the tabs on the Install Themes page.
    182182 *
    183  * The dynamic portion of the hook name, $tab, refers to the current
     183 * The dynamic portion of the hook name, `$tab`, refers to the current
    184184 * theme install tab. Possible values are 'dashboard', 'search', 'upload',
    185185 * 'featured', 'new', or 'updated'.
    186186 *
  • src/wp-admin/update-core.php

     
    649649        /**
    650650         * Fires for each custom update action on the WordPress Updates screen.
    651651         *
    652          * The dynamic portion of the hook name, $action, refers to the
     652         * The dynamic portion of the hook name, `$action`, refers to the
    653653         * passed update action. The hook fires in lieu of all available
    654654         * default update actions.
    655655         *
  • src/wp-admin/update.php

     
    261261                /**
    262262                 * Fires when a custom plugin or theme update request is received.
    263263                 *
    264                  * The dynamic portion of the hook name, $action, refers to the action
     264                 * The dynamic portion of the hook name, `$action`, refers to the action
    265265                 * provided in the request for wp-admin/update.php. Can be used to
    266266                 * provide custom update functionality for themes and plugins.
    267267                 *
  • src/wp-admin/user-edit.php

     
    440440        /**
    441441         * Filter a user contactmethod label.
    442442         *
    443          * The dynamic portion of the filter hook, $name, refers to
     443         * The dynamic portion of the filter hook, `$name`, refers to
    444444         * each of the keys in the contactmethods array.
    445445         *
    446446         * @since 2.9.0
  • src/wp-includes/capabilities.php

     
    12041204                        /**
    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
    12111211                         *
  • src/wp-includes/category-template.php

     
    12991299        /**
    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         *
    13051305         * @since 2.5.0
  • src/wp-includes/class-wp-customize-control.php

     
    320320                /**
    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 );
    331331
  • src/wp-includes/class-wp-customize-panel.php

     
    268268                /**
    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
    275275                 */
  • src/wp-includes/class-wp-customize-section.php

     
    276276                /**
    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                 *
    282282                 * @since 3.4.0
  • src/wp-includes/class-wp-customize-setting.php

     
    127127                                 * Fires when the {@see WP_Customize_Setting::preview()} method is called for settings
    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 );
    137137
     
    179179                /**
    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 );
    190190
     
    254254                        default :
    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
    263263                                 *
     
    329329                                /**
    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                                 *
    335335                                 * For settings handled as theme_mods or options, see those corresponding
     
    363363                /**
    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 );
    374374
  • src/wp-includes/comment-template.php

     
    23012301                                                                /**
    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                                                                 *
    23072307                                                                 * @since 3.0.0
  • src/wp-includes/comment.php

     
    18181818                /**
    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                 *
    18241824                 * @since 2.7.0
     
    18301830        /**
    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         *
    18361836         * Typical comment types include an empty string (standard comment), 'pingback',
  • src/wp-includes/functions.php

     
    41944194        /**
    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
    42014201         *
  • src/wp-includes/general-template.php

     
    151151        /**
    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         *
    157157         * @since 3.0.0
     
    30093009        /**
    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'.
    30193019         */
  • src/wp-includes/link-template.php

     
    15241524        /**
    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         *
    15301530         * @since 2.5.0
     
    15381538        /**
    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.
    15491549         */
     
    15521552        /**
    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" );
    15631563
     
    16241624        /**
    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         *
    16301630         * @since 2.8.0
     
    18611861        /**
    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         *
    18671867         * @since 2.6.0
  • src/wp-includes/media.php

     
    19421942        /**
    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         *
    19481948         * @since 3.5.0
  • src/wp-includes/meta.php

     
    5454        /**
    5555         * Filter whether to add metadata of a specific type.
    5656         *
    57          * The dynamic portion of the hook, $meta_type, refers to the meta
     57         * The dynamic portion of the hook, `$meta_type`, refers to the meta
    5858         * object type (comment, post, or user). Returning a non-null value
    5959         * will effectively short-circuit the function.
    6060         *
     
    8282        /**
    8383         * Fires immediately before meta of a specific type is added.
    8484         *
    85          * The dynamic portion of the hook, $meta_type, refers to the meta
     85         * The dynamic portion of the hook, `$meta_type`, refers to the meta
    8686         * object type (comment, post, or user).
    8787         *
    8888         * @since 3.1.0
     
    109109        /**
    110110         * Fires immediately after meta of a specific type is added.
    111111         *
    112          * The dynamic portion of the hook, $meta_type, refers to the meta
     112         * The dynamic portion of the hook, `$meta_type`, refers to the meta
    113113         * object type (comment, post, or user).
    114114         *
    115115         * @since 2.9.0
     
    169169        /**
    170170         * Filter whether to update metadata of a specific type.
    171171         *
    172          * The dynamic portion of the hook, $meta_type, refers to the meta
     172         * The dynamic portion of the hook, `$meta_type`, refers to the meta
    173173         * object type (comment, post, or user). Returning a non-null value
    174174         * will effectively short-circuit the function.
    175175         *
     
    216216                /**
    217217                 * Fires immediately before updating metadata of a specific type.
    218218                 *
    219                  * The dynamic portion of the hook, $meta_type, refers to the meta
     219                 * The dynamic portion of the hook, `$meta_type`, refers to the meta
    220220                 * object type (comment, post, or user).
    221221                 *
    222222                 * @since 2.9.0
     
    255255                /**
    256256                 * Fires immediately after updating metadata of a specific type.
    257257                 *
    258                  * The dynamic portion of the hook, $meta_type, refers to the meta
     258                 * The dynamic portion of the hook, `$meta_type`, refers to the meta
    259259                 * object type (comment, post, or user).
    260260                 *
    261261                 * @since 2.9.0
     
    330330        /**
    331331         * Filter whether to delete metadata of a specific type.
    332332         *
    333          * The dynamic portion of the hook, $meta_type, refers to the meta
     333         * The dynamic portion of the hook, `$meta_type`, refers to the meta
    334334         * object type (comment, post, or user). Returning a non-null value
    335335         * will effectively short-circuit the function.
    336336         *
     
    369369        /**
    370370         * Fires immediately before deleting metadata of a specific type.
    371371         *
    372          * The dynamic portion of the hook, $meta_type, refers to the meta
     372         * The dynamic portion of the hook, `$meta_type`, refers to the meta
    373373         * object type (comment, post, or user).
    374374         *
    375375         * @since 3.1.0
     
    411411        /**
    412412         * Fires immediately after deleting metadata of a specific type.
    413413         *
    414          * The dynamic portion of the hook name, $meta_type, refers to the meta
     414         * The dynamic portion of the hook name, `$meta_type`, refers to the meta
    415415         * object type (comment, post, or user).
    416416         *
    417417         * @since 2.9.0
     
    464464        /**
    465465         * Filter whether to retrieve metadata of a specific type.
    466466         *
    467          * The dynamic portion of the hook, $meta_type, refers to the meta
     467         * The dynamic portion of the hook, `$meta_type`, refers to the meta
    468468         * object type (comment, post, or user). Returning a non-null value
    469469         * will effectively short-circuit the function.
    470470         *
     
    724724                        /**
    725725                         * Fires immediately before deleting post or comment metadata of a specific type.
    726726                         *
    727                          * The dynamic portion of the hook, $meta_type, refers to the meta
     727                         * The dynamic portion of the hook, `$meta_type`, refers to the meta
    728728                         * object type (post or comment).
    729729                         *
    730730                         * @since 3.4.0
     
    748748                        /**
    749749                         * Fires immediately after deleting post or comment metadata of a specific type.
    750750                         *
    751                          * The dynamic portion of the hook, $meta_type, refers to the meta
     751                         * The dynamic portion of the hook, `$meta_type`, refers to the meta
    752752                         * object type (post or comment).
    753753                         *
    754754                         * @since 3.4.0
     
    15721572        /**
    15731573         * Filter the sanitization of a specific meta key of a specific meta type.
    15741574         *
    1575          * The dynamic portions of the hook name, $meta_type and $meta_key, refer to the
    1576          * metadata object type (comment, post, or user) and the meta key value,
    1577          * respectively.
     1575         * The dynamic portions of the hook name, `$meta_type`, and `$meta_key`,
     1576         * refer to the metadata object type (comment, post, or user) and the meta
     1577         * key value, respectively.
    15781578         *
    15791579         * @since 3.3.0
    15801580         *
  • src/wp-includes/ms-blogs.php

     
    460460        /**
    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
    466466         *
  • src/wp-includes/option.php

     
    3232        /**
    3333         * Filter the value of an existing option before it is retrieved.
    3434         *
    35          * The dynamic portion of the hook name, $option, refers to the option name.
     35         * The dynamic portion of the hook name, `$option`, refers to the option name.
    3636         *
    3737         * Passing a truthy value to the filter will short-circuit retrieving
    3838         * the option value, returning the passed value instead.
     
    5757                        /**
    5858                         * Filter the default value for an option.
    5959                         *
    60                          * The dynamic portion of the hook name, $option, refers
    61                          * to the option name.
     60                         * The dynamic portion of the hook name, `$option`, refers to the option name.
    6261                         *
    6362                         * @since 3.4.0
    6463                         *
    65                          * @param mixed $default The default value to return if the option
    66                          *                       does not exist in the database.
     64                         * @param mixed $default The default value to return if the option does not exist
     65                         *                       in the database.
    6766                         */
    6867                        return apply_filters( 'default_option_' . $option, $default );
    6968
     
    112111        /**
    113112         * Filter the value of an existing option.
    114113         *
    115          * The dynamic portion of the hook name, $option, refers to the option name.
     114         * The dynamic portion of the hook name, `$option`, refers to the option name.
    116115         *
    117116         * @since 1.5.0 As 'option_' . $setting
    118117         * @since 3.0.0
     
    245244        /**
    246245         * Filter a specific option before its value is (maybe) serialized and updated.
    247246         *
    248          * The dynamic portion of the hook name, $option, refers to the option name.
     247         * The dynamic portion of the hook name, `$option`, refers to the option name.
    249248         *
    250249         * @since 2.6.0
    251250         *
     
    308307        /**
    309308         * Fires after the value of a specific option has been successfully updated.
    310309         *
    311          * The dynamic portion of the hook name, $option, refers to the option name.
     310         * The dynamic portion of the hook name, `$option`, refers to the option name.
    312311         *
    313312         * @since 2.0.1
    314313         *
     
    410409        /**
    411410         * Fires after a specific option has been added.
    412411         *
    413          * The dynamic portion of the hook name, $option, refers to the option name.
     412         * The dynamic portion of the hook name, `$option`, refers to the option name.
    414413         *
    415414         * @since 2.5.0 As "add_option_{$name}"
    416415         * @since 3.0.0
     
    480479                /**
    481480                 * Fires after a specific option has been deleted.
    482481                 *
    483                  * The dynamic portion of the hook name, $option, refers to the option name.
     482                 * The dynamic portion of the hook name, `$option`, refers to the option name.
    484483                 *
    485484                 * @since 3.0.0
    486485                 *
     
    514513        /**
    515514         * Fires immediately before a specific transient is deleted.
    516515         *
    517          * The dynamic portion of the hook name, $transient, refers to the transient name.
     516         * The dynamic portion of the hook name, `$transient`, refers to the transient name.
    518517         *
    519518         * @since 3.0.0
    520519         *
     
    563562        /**
    564563         * Filter the value of an existing transient.
    565564         *
    566          * The dynamic portion of the hook name, $transient, refers to the transient name.
     565         * The dynamic portion of the hook name, `$transient`, refers to the transient name.
    567566         *
    568567         * Passing a truthy value to the filter will effectively short-circuit retrieval
    569568         * of the transient, returning the passed value instead.
     
    602601        /**
    603602         * Filter an existing transient's value.
    604603         *
    605          * The dynamic portion of the hook name, $transient, refers to the transient name.
     604         * The dynamic portion of the hook name, `$transient`, refers to the transient name.
    606605         *
    607606         * @since 2.8.0
    608607         *
     
    631630        /**
    632631         * Filter a specific transient before its value is set.
    633632         *
    634          * The dynamic portion of the hook name, $transient, refers to the transient name.
     633         * The dynamic portion of the hook name, `$transient`, refers to the transient name.
    635634         *
    636635         * @since 3.0.0
    637636         *
     
    678677                /**
    679678                 * Fires after the value for a specific transient has been set.
    680679                 *
    681                  * The dynamic portion of the hook name, $transient, refers to the transient name.
     680                 * The dynamic portion of the hook name, `$transient`, refers to the transient name.
    682681                 *
    683682                 * @since 3.0.0
    684683                 *
     
    933932        /**
    934933         * Filter an existing site option before it is retrieved.
    935934         *
    936          * The dynamic portion of the hook name, $option, refers to the option name.
     935         * The dynamic portion of the hook name, `$option`, refers to the option name.
    937936         *
    938937         * Passing a truthy value to the filter will effectively short-circuit retrieval,
    939938         * returning the passed value instead.
     
    957956                /**
    958957                 * Filter a specific default site option.
    959958                 *
    960                  * The dynamic portion of the hook name, $option, refers to the option name.
     959                 * The dynamic portion of the hook name, `$option`, refers to the option name.
    961960                 *
    962961                 * @since 3.4.0
    963962                 *
     
    998997        /**
    999998         * Filter the value of an existing site option.
    1000999         *
    1001          * The dynamic portion of the hook name, $option, refers to the option name.
     1000         * The dynamic portion of the hook name, `$option`, refers to the option name.
    10021001         *
    10031002         * @since 2.9.0 As 'site_option_' . $key
    10041003         * @since 3.0.0
     
    10291028        /**
    10301029         * Filter the value of a specific site option before it is added.
    10311030         *
    1032          * The dynamic portion of the hook name, $option, refers to the option name.
     1031         * The dynamic portion of the hook name, `$option`, refers to the option name.
    10331032         *
    10341033         * @since 2.9.0 As 'pre_add_site_option_' . $key
    10351034         * @since 3.0.0
     
    10741073                /**
    10751074                 * Fires after a specific site option has been successfully added.
    10761075                 *
    1077                  * The dynamic portion of the hook name, $option, refers to the option name.
     1076                 * The dynamic portion of the hook name, `$option`, refers to the option name.
    10781077                 *
    10791078                 * @since 2.9.0 As "add_site_option_{$key}"
    10801079                 * @since 3.0.0
     
    11171116        /**
    11181117         * Fires immediately before a specific site option is deleted.
    11191118         *
    1120          * The dynamic portion of the hook name, $option, refers to the option name.
     1119         * The dynamic portion of the hook name, `$option`, refers to the option name.
    11211120         *
    11221121         * @since 3.0.0
    11231122         */
     
    11401139                /**
    11411140                 * Fires after a specific site option has been deleted.
    11421141                 *
    1143                  * The dynamic portion of the hook name, $option, refers to the option name.
     1142                 * The dynamic portion of the hook name, `$option`, refers to the option name.
    11441143                 *
    11451144                 * @since 2.9.0 As "delete_site_option_{$key}"
    11461145                 * @since 3.0.0
     
    11841183        /**
    11851184         * Filter a specific site option before its value is updated.
    11861185         *
    1187          * The dynamic portion of the hook name, $option, refers to the option name.
     1186         * The dynamic portion of the hook name, `$option`, refers to the option name.
    11881187         *
    11891188         * @since 2.9.0 As 'pre_update_site_option_' . $key
    11901189         * @since 3.0.0
     
    12261225                /**
    12271226                 * Fires after the value of a specific site option has been successfully updated.
    12281227                 *
    1229                  * The dynamic portion of the hook name, $option, refers to the option name.
     1228                 * The dynamic portion of the hook name, `$option`, refers to the option name.
    12301229                 *
    12311230                 * @since 2.9.0 As "update_site_option_{$key}"
    12321231                 * @since 3.0.0
     
    12661265        /**
    12671266         * Fires immediately before a specific site transient is deleted.
    12681267         *
    1269          * The dynamic portion of the hook name, $transient, refers to the transient name.
     1268         * The dynamic portion of the hook name, `$transient`, refers to the transient name.
    12701269         *
    12711270         * @since 3.0.0
    12721271         *
     
    13161315        /**
    13171316         * Filter the value of an existing site transient.
    13181317         *
    1319          * The dynamic portion of the hook name, $transient, refers to the transient name.
     1318         * The dynamic portion of the hook name, `$transient`, refers to the transient name.
    13201319         *
    13211320         * Passing a truthy value to the filter will effectively short-circuit retrieval,
    13221321         * returning the passed value instead.
     
    13551354        /**
    13561355         * Filter the value of an existing site transient.
    13571356         *
    1358          * The dynamic portion of the hook name, $transient, refers to the transient name.
     1357         * The dynamic portion of the hook name, `$transient`, refers to the transient name.
    13591358         *
    13601359         * @since 2.9.0
    13611360         *
     
    13851384        /**
    13861385         * Filter the value of a specific site transient before it is set.
    13871386         *
    1388          * The dynamic portion of the hook name, $transient, refers to the transient name.
     1387         * The dynamic portion of the hook name, `$transient`, refers to the transient name.
    13891388         *
    13901389         * @since 3.0.0
    13911390         *
     
    14151414                /**
    14161415                 * Fires after the value for a specific site transient has been set.
    14171416                 *
    1418                  * The dynamic portion of the hook name, $transient, refers to the transient name.
     1417                 * The dynamic portion of the hook name, `$transient`, refers to the transient name.
    14191418                 *
    14201419                 * @since 3.0.0
    14211420                 *
  • src/wp-includes/post.php

     
    16411641        /**
    16421642         * Filter the labels of a specific post type.
    16431643         *
    1644          * The dynamic portion of the hook name, $post_type, refers to
     1644         * The dynamic portion of the hook name, `$post_type`, refers to
    16451645         * the post type slug.
    16461646         *
    16471647         * @since 3.5.0
     
    21452145                        /**
    21462146                         * Filter the value of a specific post field to edit.
    21472147                         *
    2148                          * The dynamic portion of the hook name, $field, refers to the post
     2148                         * The dynamic portion of the hook name, `$field`, refers to the post
    21492149                         * field name.
    21502150                         *
    21512151                         * @since 2.3.0
     
    21582158                        /**
    21592159                         * Filter the value of a specific post field to edit.
    21602160                         *
    2161                          * The dynamic portion of the hook name, $field_no_prefix, refers to
     2161                         * The dynamic portion of the hook name, `$field_no_prefix`, refers to
    21622162                         * the post field name.
    21632163                         *
    21642164                         * @since 2.3.0
     
    21852185                        /**
    21862186                         * Filter the value of a specific post field before saving.
    21872187                         *
    2188                          * The dynamic portion of the hook name, $field, refers to the post
     2188                         * The dynamic portion of the hook name, `$field`, refers to the post
    21892189                         * field name.
    21902190                         *
    21912191                         * @since 2.3.0
     
    21972197                        /**
    21982198                         * Filter the value of a specific field before saving.
    21992199                         *
    2200                          * The dynamic portion of the hook name, $field_no_prefix, refers
     2200                         * The dynamic portion of the hook name, `$field_no_prefix`, refers
    22012201                         * to the post field name.
    22022202                         *
    22032203                         * @since 2.3.0
     
    22112211                        /**
    22122212                         * Filter the value of a specific post field before saving.
    22132213                         *
    2214                          * The dynamic portion of the hook name, $field, refers to the post
     2214                         * The dynamic portion of the hook name, `$field`, refers to the post
    22152215                         * field name.
    22162216                         *
    22172217                         * @since 2.3.0
     
    22282228                        /**
    22292229                         * Filter the value of a specific post field for display.
    22302230                         *
    2231                          * The dynamic portion of the hook name, $field, refers to the post
     2231                         * The dynamic portion of the hook name, `$field`, refers to the post
    22322232                         * field name.
    22332233                         *
    22342234                         * @since 2.3.0
     
    34773477        /**
    34783478         * Fires once a post has been saved.
    34793479         *
    3480          * The dynamic portion of the hook name, $post->post_type, refers to
     3480         * The dynamic portion of the hook name, `$post->post_type`, refers to
    34813481         * the post type slug.
    34823482         *
    34833483         * @since 3.7.0
     
    39353935        /**
    39363936         * Fires when a post is transitioned from one status to another.
    39373937         *
    3938          * The dynamic portions of the hook name, $new_status and $old status,
     3938         * The dynamic portions of the hook name, `$new_status` and `$old status`,
    39393939         * refer to the old and new post statuses, respectively.
    39403940         *
    39413941         * @since 2.3.0
     
    39473947        /**
    39483948         * Fires when a post is transitioned from one status to another.
    39493949         *
    3950          * The dynamic portions of the hook name, $new_status and $post->post_type,
     3950         * The dynamic portions of the hook name, `$new_status` and `$post->post_type`,
    39513951         * refer to the new post status and post type, respectively.
    39523952         *
    39533953         * @since 2.3.0
  • src/wp-includes/rewrite.php

     
    16761676                        /**
    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.
    16821682                         *
  • src/wp-includes/taxonomy.php

     
    13391339        /**
    13401340         * Filter a taxonomy.
    13411341         *
    1342          * The dynamic portion of the filter name, $taxonomy, refers
     1342         * The dynamic portion of the filter name, `$taxonomy`, refers
    13431343         * to the taxonomy slug.
    13441344         *
    13451345         * @since 2.3.0
     
    21902190                /**
    21912191                 * Filter a term field to edit before it is sanitized.
    21922192                 *
    2193                  * The dynamic portion of the filter name, $field, refers to the term field.
     2193                 * The dynamic portion of the filter name, `$field`, refers to the term field.
    21942194                 *
    21952195                 * @since 2.3.0
    21962196                 *
     
    22032203                /**
    22042204                 * Filter the taxonomy field to edit before it is sanitized.
    22052205                 *
    2206                  * The dynamic portions of the filter name, $taxonomy, and $field, refer
     2206                 * The dynamic portions of the filter name, `$taxonomy` and `$field`, refer
    22072207                 * to the taxonomy slug and taxonomy field, respectively.
    22082208                 *
    22092209                 * @since 2.3.0
     
    22212221                /**
    22222222                 * Filter a term field value before it is sanitized.
    22232223                 *
    2224                  * The dynamic portion of the filter name, $field, refers to the term field.
     2224                 * The dynamic portion of the filter name, `$field`, refers to the term field.
    22252225                 *
    22262226                 * @since 2.3.0
    22272227                 *
     
    22332233                /**
    22342234                 * Filter a taxonomy field before it is sanitized.
    22352235                 *
    2236                  * The dynamic portions of the filter name, $taxonomy, and $field, refer
     2236                 * The dynamic portions of the filter name, `$taxonomy` and `$field`, refer
    22372237                 * to the taxonomy slug and field name, respectively.
    22382238                 *
    22392239                 * @since 2.3.0
     
    22602260                /**
    22612261                 * Filter the term field for use in RSS.
    22622262                 *
    2263                  * The dynamic portion of the filter name, $field, refers to the term field.
     2263                 * The dynamic portion of the filter name, `$field`, refers to the term field.
    22642264                 *
    22652265                 * @since 2.3.0
    22662266                 *
     
    22722272                /**
    22732273                 * Filter the taxonomy field for use in RSS.
    22742274                 *
    2275                  * The dynamic portions of the hook name, $taxonomy, and $field, refer
     2275                 * The dynamic portions of the hook name, `$taxonomy`, and $field, refer
    22762276                 * to the taxonomy slug and field name, respectively.
    22772277                 *
    22782278                 * @since 2.3.0
     
    22862286                /**
    22872287                 * Filter the term field sanitized for display.
    22882288                 *
    2289                  * The dynamic portion of the filter name, $field, refers to the term field name.
     2289                 * The dynamic portion of the filter name, `$field`, refers to the term field name.
    22902290                 *
    22912291                 * @since 2.3.0
    22922292                 *
     
    23002300                /**
    23012301                 * Filter the taxonomy field sanitized for display.
    23022302                 *
    2303                  * The dynamic portions of the filter name, $taxonomy, and $field, refer
     2303                 * The dynamic portions of the filter name, `$taxonomy`, and $field, refer
    23042304                 * to the taxonomy slug and taxonomy field, respectively.
    23052305                 *
    23062306                 * @since 2.3.0
     
    25332533        /**
    25342534         * Fires after a term in a specific taxonomy is deleted.
    25352535         *
    2536          * The dynamic portion of the hook name, $taxonomy, refers to the specific
     2536         * The dynamic portion of the hook name, `$taxonomy`, refers to the specific
    25372537         * taxonomy the term belonged to.
    25382538         *
    25392539         * @since 2.3.0
     
    25412541         * @param int     $term         Term ID.
    25422542         * @param int     $tt_id        Term taxonomy ID.
    25432543         * @param mixed   $deleted_term Copy of the already-deleted term, in the form specified
    2544          *                              by the parent function. WP_Error otherwise.
     2544         *                              by the parent function. {@see WP_Error} otherwise.
    25452545         */
    25462546        do_action( "delete_$taxonomy", $term, $tt_id, $deleted_term );
    25472547
     
    29252925        /**
    29262926         * Fires after a new term is created for a specific taxonomy.
    29272927         *
    2928          * The dynamic portion of the hook name, $taxonomy, refers
     2928         * The dynamic portion of the hook name, `$taxonomy`, refers
    29292929         * to the slug of the taxonomy the term was created for.
    29302930         *
    29312931         * @since 2.3.0
     
    34573457         * Fires after a term in a specific taxonomy has been updated, but before the term
    34583458         * cache has been cleaned.
    34593459         *
    3460          * The dynamic portion of the hook name, $taxonomy, refers to the taxonomy slug.
     3460         * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
    34613461         *
    34623462         * @since 2.3.0
    34633463         *
     
    34863486         * Fires after a term for a specific taxonomy has been updated, and the term
    34873487         * cache has been cleaned.
    34883488         *
    3489          * The dynamic portion of the hook name, $taxonomy, refers to the taxonomy slug.
     3489         * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
    34903490         *
    34913491         * @since 2.3.0
    34923492         *
  • src/wp-includes/template.php

     
    3030        /**
    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.
    3636         *
    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 );
    4242}
  • src/wp-includes/theme.php

     
    909909                /**
    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
    915915                 * on the theme options.
     
    943943        /**
    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.
    949949         *
     
    18161816        /**
    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
    18251824         *
  • src/wp-includes/user.php

     
    371371        /**
    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
    377377         *
     
    14991499                        /**
    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                         *
    15051505                         * @since 2.9.0
     
    15231523                        /**
    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                         *
    15291529                         * @since 2.9.0
     
    15431543                        /**
    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                         *
    15491549                         * @since 2.9.0
  • src/wp-login.php

     
    447447/**
    448448 * Fires before a specified login form action.
    449449 *
    450  * The dynamic portion of the hook name, $action, refers to the action
     450 * The dynamic portion of the hook name, `$action`, refers to the action
    451451 * that brought the visitor to the login form. Actions include 'postpass',
    452452 * 'logout', 'lostpassword', etc.
    453453 *