Make WordPress Core


Ignore:
Timestamp:
11/30/2014 11:52:33 AM (10 years ago)
Author:
DrewAPicture
Message:

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

Affects DocBlocks for the following hooks:

  • pre_option_ . $option
  • default_option_ . $option
  • option_ . $option
  • pre_update_option_ . $option
  • update_option_{$option}
  • add_option_{$option}
  • delete_option_$option
  • delete_transient_ . $transient
  • pre_transient_ . $transient
  • transient_ . $transient
  • pre_set_transient_ . $transient
  • set_transient_ . $transient
  • pre_site_option_ . $option
  • default_site_option_ . $option
  • site_option_ . $option
  • pre_add_site_option_ . $option
  • add_site_option_{$option}
  • pre_delete_site_option_ . $option
  • delete_site_option_{$option}
  • pre_update_site_option_ . $option
  • update_site_option_{$option}
  • delete_site_transient_ . $transient
  • pre_site_transient_ . $transient
  • site_transient_ . $transient
  • pre_set_site_transient_ . $transient
  • set_site_transient_ . $transient

See #30552.

File:
1 edited

Legend:

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

    r30105 r30652  
    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
     
    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 );
     
    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
     
    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
     
    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
     
    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}"
     
    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
     
    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
     
    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
     
    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
     
    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
     
    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
     
    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,
     
    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
     
    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
     
    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
     
    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}"
     
    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
     
    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}"
     
    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
     
    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}"
     
    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
     
    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,
     
    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
     
    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
     
    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
Note: See TracChangeset for help on using the changeset viewer.