来源： 标签/6.5/型钢混凝土/wp包括/类wp-widget.php

<?php（电话）
/**
*小工具API:WP_Widget基类
 *
*@package WordPress
*@子包小工具
*@自4.4.0起
*/

/**
*扩展核心基类以注册小部件。
 *
*必须为每个小部件扩展此类，并且必须覆盖WP_widget:：widget（）。
 *
*如果添加小部件选项，WP_widget:：update（）和WP_Wigget:：form（）也应被覆盖。
 *
*@自2.8.0起
*@自4.4.0起从wp-includes/widgets.php移动到自己的文件
 */
#[允许动态属性]
班 WP_小工具 {

       /**
*此类型的所有小部件的根ID。
         *
*@自2.8.0起
*@var混合|string
         */
       公众的 $id基础；

       /**
*此小部件类型的名称。
         *
*@自2.8.0起
*@var字符串
         */
       公众的 $名称；

       /**
*此小部件类型的选项名称。
         *
*@自2.8.0起
*@var字符串
         */
       公众的 $option_name（选项名称）；

       /**
*此小部件类型的Alt选项名称。
         *
*@自2.8.0起
*@var字符串
         */
       公众的 $可选名称；

       /**
*传递给wp_register_sidebar_widget（）的选项数组。
         *
*@自2.8.0起
*@var数组
         */
       公众的 $小部件选项；

       /**
*传递给wp_register_widget_control（）的选项数组。
         *
*@自2.8.0起
*@var数组
         */
       公众的 $控制选项；

       /**
*当前实例的唯一ID号。
         *
*@自2.8.0起
*@var bool|int
         */
       公众的 $个 = 假；

       /**
*当前实例的唯一ID字符串（ID_base-number）。
         *
*@自2.8.0起
*@var bool|string
         */
       公众的 $id（美元） = 假；

       /**
*小部件数据是否已更新。
         *
*在POST提交后更新数据时设置为true-确保数据更新
*不会发生两次。
         *
*@自2.8.0起
*@var bool
         */
       公众的 $已更新 = 假；

       //
       //必须由子类覆盖的成员函数。
       //

       /**
*回显小部件内容。
         *
*子类应覆盖此函数以生成其小部件代码。
         *
*@自2.8.0起
         *
*@param array$args显示参数，包括'before_title'、'after_title'，
*'before_widget'和'after_widget]。
*@param array$instance小部件特定实例的设置。
         */
       公众的 功能 小装置( $个参数, $实例 ) {
               死亡( “必须在子类中重写函数WP_Widget:：Widget（）。” );
       }

       /**
*更新小部件的特定实例。
         *
*此函数应检查`$new_instance`是否设置正确。新计算的
*应返回`$instance`的值。如果返回false，则实例不会
*已保存/更新。
         *
*@自2.8.0起
         *
*@param array$new_instance用户通过输入此实例的新设置
*WP_Widget:：form（）。
*@param array$old_instance此实例的旧设置。
*@return array Settings可保存，bool false可取消保存。
         */
       公众的 功能 更新( $新实例, $old_instance（旧实例） ) {
               返回 $新实例；
       }

       /**
*输出设置更新表单。
         *
*@自2.8.0起
         *
*@param array$instance当前设置。
*@return string默认返回为“noform”。
         */
       公众的 功能 形式( $实例 ) {
               回声 '<p class=“no-options-widget”>' . __( “此小部件没有选项。” ) . “</p>”；
               返回 “无格式”；
       }

       //您需要调用的函数。

       /**
*PHP5构造函数。
         *
*@自2.8.0起
         *
*@param string$id_base小部件的基本id，小写且唯一。如果留空，
*将使用小部件的PHP类名的一部分。必须是独一无二的。
*@param string$name配置页面上显示的小部件的名称。
*@param array$widget_options可选。小工具选项。请参阅wp_register_sidebar_widget（）了解
*关于已接受参数的信息。默认空数组。
*@param array$control_options可选。小工具控制选项。请参阅wp_register_widget_control（）了解
*关于已接受参数的信息。默认空数组。
         */
       公众的 功能 __构造( $id_基础, $名称, $小部件选项 = 阵列(), $控制选项 = 阵列() ) {
               如果 ( ! 空的( $id基础 ) ) {
                       $id基础 = 斯特劳尔( $id基础 );
               } 其他的 {
                       $id_基础 = preg_替换( '/（wp_）？小部件_/', '', 斯特劳尔( 获取类（_C）( $这个 ) ) );
               }

               $这个->id基础（_B）         = $id基础；
               $这个->名称           = $名称；
               $这个->选项名称     = '小部件_' . $这个->id基础（_B）；
               $这个->小部件选项（_O） = wp_parse_args(
                       $小部件选项,
                       阵列(
                               '类名称'                   => str_替换( '\\', '_', $这个->选项名称 ),
                               '自定义_选择_刷新' => 假,
                       )
               );
               $这个->控制选项（_O） = wp_parse_args( $控制选项, 阵列( 'id基础' => $这个->id基础（_B） ) );
       }

       /**
*PHP4构造函数。
         *
*@自2.8.0起
*@已弃用4.3.0请改用__construct（）。
         *
*@请参阅WP_Widget:：__construct（）
         *
*@param string$id_base小部件的基本id，小写且唯一。如果留空，
*将使用小部件的PHP类名的一部分。必须是独一无二的。
*@param string$name配置页面上显示的小部件的名称。
*@param array$widget_options可选。小工具选项。请参阅wp_register_sidebar_widget（）了解
*关于公认论点的信息。默认空数组。
*@param array$control_options可选。小工具控制选项。请参阅wp_register_widget_control（）了解
*关于已接受参数的信息。默认空数组。
         */
       公众的 功能 WP_小工具( $id基础, $名称, $小部件选项 = 阵列(), $控制选项 = 阵列() ) {
               _已弃用的构造函数( “WP_Widget”, “4.3.0”, 获取类（_C）( $这个 ) );
               WP_小工具::__构造( $id基础, $名称, $小部件选项, $控制选项 );
       }

       /**
*构造用于form（）字段的名称属性
         *
*此函数应在form（）方法中使用，以创建字段的名称属性
*由update（）保存
         *
*@自2.8.0起
*@自4.4.0以来，现在接受数组格式字段名。
         *
*@param string$field_name字段名。
*@return string `$field_Name`的Name属性。
         */
       公众的 功能 获取字段名称( $字段名称 ) {
               百万美元 = 斯特波斯( $字段名, '[' );

               如果 ( 假 !== 百万美元 ) {
                       //将第一次出现的“[”替换为“][”。
                       $字段名 = '[' . substr_replace（子替换）( $字段名称, '][', 百万美元, 斯特伦( '[' ) );
               } 其他的 {
                       $字段名 = '[' . $字段名 . ']'；
               }

               返回 '小部件-' . $这个->id基础（_B） . '[' . $这个->数 . ']' . $字段名；
       }

       /**
*构造用于WP_Widget:：form（）字段的id属性。
         *
*此函数应在form（）方法中用于创建id属性
*用于WP_Widget:：update（）保存的字段。
         *
*@自2.8.0起
*@自4.4.0以来，现在接受数组格式字段ID。
         *
*@param string$field_name字段名。
*@return `$field_name`的字符串ID属性。
         */
       公众的 功能 获取字段id( $字段名 ) {
               $字段名 = str_替换( 阵列( '[]', '[', ']' ), 阵列( '', '-', '' ), $字段名 );
               $字段名 = 修剪( $字段名, '-' );

               返回 '小部件-' . $这个->id基础（_B） . '-' . $这个->数 . '-' . $字段名称；
       }

       /**
*注册此小部件类的所有小部件实例。
         *
*@自2.8.0起
         */
       公众的 功能 _寄存器() {
               $设置 = $这个->获取设置（_S）（）；
               $空   = 真的；

               //当$settings是类似数组的对象时，获取一个内部数组以与array_keys（）一起使用。
               如果 ( $设置 运算符 数组对象 || $设置 运算符 数组迭代器 ) {
                       $设置 = $设置->获取阵列副本（）；
               }

               如果 ( 是数组（_A）( $设置 ) ) {
                       foreach公司 ( 数组键( $设置 ) 作为 $个 ) {
                               如果 ( 是数字（_N）( $个 ) ) {
                                       $这个->_套( $个 );
                                       $这个->_寄存器_一( $个 );
                                       $空 = 假；
                               }
                       }
               }

               如果 ( $空 ) {
                       //如果没有，我们用一个通用模板来注册小部件的存在。
                       $这个->_套( 1 );
                       $这个->_寄存器_一（）；
               }
       }

       /**
*设置小部件实例的内部订单号。
         *
*@自2.8.0起
         *
*@param int$number此小部件实例与其他小部件实例相比的唯一订单号
*同一类的实例。
         */
       公众的 功能 _套( $个 ) {
               $这个->数 = $数字；
               $这个->身份证件     = $这个->id基础（_B） . '-' . $个；
       }

       /**
*检索小部件显示回调。
         *
*@自2.8.0起
         *
*@return可调用显示回调。
         */
       公众的 功能 _获取显示回调() {
               返回 阵列( $这个, '显示回调' );
       }

       /**
*检索小部件更新回调。
         *
*@自2.8.0起
         *
*@return可调用更新回调。
         */
       公众的 功能 _获取更新回拨() {
               返回 阵列( $这个, '更新回调' );
       }

       /**
*检索表单回调。
         *
*@自2.8.0起
         *
*@return可调用窗体回调。
         */
       公众的 功能 _获取表单回调() {
               返回 阵列( $这个, '表单回调' );
       }

       /**
*确定当前请求是否在Customizer预览中。
         *
*如果为true，则当前请求位于Customizer预览中，然后
*对象缓存被挂起，小部件应检查此项以决定
*是否应将任何内容持久存储到对象缓存，
*瞬变或其他任何地方。
         *
*@自3.9.0起
         *
*@global WP_Customize_Manager$WP_Customize
         *
*@return bool如果在Customizer预览中，则为True，否则为false。
         */
       公众的 功能 is_preview（预览）() {
               全球的 $wp_自定义；
               返回 ( 发行( $wp_自定义 ) && $wp_自定义->is_preview（预览）() );
       }

       /**
*生成实际的小部件内容（请勿覆盖）。
         *
*查找实例并调用WP_Widget:：Widget（）。
         *
*@自2.8.0起
         *
*@param array$args显示参数。有关信息，请参阅WP_Widget:：Widget（）
*基于已接受的论点。
*@param int |数组$widget_args{
*可选。小部件实例的内部订单号或多小部件参数数组。
*默认值1。
         *
*@type int$number用于同一小部件的倍数的数字增量。
         * }
         */
       公众的 功能 显示_回调( $个参数, $小部件_参数 = 1 ) {
               如果 ( 是数字（_N）( $小部件_参数 ) ) {
                       $小部件_参数 = 阵列( “数字” => $小部件_参数 );
               }

               $小部件_参数 = wp_parse_args( $小部件_参数, 阵列( “数字” => -1 ) );
               $这个->_集合( $小部件_参数[“数字”] );
               $个实例 = $这个->获取设置（_S）（）；

               如果 ( 发行( $个实例[ $这个->数 ] ) ) {
                       $实例 = $个实例[ $这个->数 ];

                       /**
*过滤特定小部件实例的设置。
                         *
*返回false将有效地缩短小部件的显示。
                         *
*@自2.8.0起
                         *
*@param array$instance当前小部件实例的设置。
*@param WP_Widget$小部件当前小部件实例。
*@param array$args默认小部件参数的数组。
                         */
                       $实例 = 应用筛选器( '小工具_显示_回调', $实例, $这个, $个参数 );

                       如果 ( 假 === $实例 ) {
                               返回；
                       }

                       $was_cache_addition_suspended = wp_suspend_cache_addition（暂停缓存添加）（）；
                       如果 ( $这个->is_preview（预览）() && ! $was_cache_addition_suspended ) {
                               wp_suspend_cache_addition（暂停缓存添加）( 真的 );
                       }

                       $这个->小装置( $个参数, $实例 );

                       如果 ( $这个->is_preview（预览）() ) {
                               wp_suspend_cache_addition（暂停缓存添加）( $was_cache_addition_suspended );
                       }
               }
       }

       /**
*处理更改的设置（请勿覆盖）。
         *
*@自2.8.0起
         *
*@全局数组$wp_registered_widgets
         *
*@param int$已弃用未使用。
         */
       公众的 功能 update_callback（更新回拨）( $已弃用 = 1 ) {
               全球的 $wp_注册_widgets；

               $所有实例 = $这个->获取设置（_S）（）；

               //我们需要更新数据。
               如果 ( $这个->已更新 ) {
                       返回；
               }

               如果 ( 发行( $_POST（发送）['删除小部件'] ) && $_POST（发送）['删除小部件'] ) {
                       //删除此小部件实例的设置。
                       如果 ( 发行( $_POST（发送）[“widget-id”] ) ) {
                               $删除id = $_POST（发送）[“widget-id”];
                       } 其他的 {
                               返回；
                       }

                       如果 ( isset公司( $wp_注册_widgets[ $删除id ]['参数'][0][“数字”] ) ) {
                               $个 = $wp_注册_widgets[ $删除id ]['参数'][0][“数字”];

                               如果 ( $这个->id基础（_B） . '-' . $个 === $删除id ) {
                                       未设置( $所有实例[ $个 ] );
                               }
                       }
               } 其他的 {
                       如果 ( 发行( $_POST（发送）[ '小部件-' . $这个->id基础（_B） ] ) && 是数组（_A）( $_POST（发送）[ '小部件-' . $这个->id基础（_B） ] ) ) {
                               $设置 = $_成本[ '小部件-' . $这个->id基础（_B） ];
                       } 埃尔塞夫 ( 发行( $_POST（发送）['id基础'] ) && $_POST（发送）['id基础'] === $这个->id基础（_B） ) {
                               $num个     = $_POST（发送）['多重编号'] ? (整数) $_POST（发送）['多编号'] : (整数) $_POST（发送）['小部件编号'];
                               $设置 = 阵列( $num个 => 阵列() );
                       } 其他的 {
                               返回；
                       }

                       foreach公司 ( $设置 作为 $个 => $新实例 ) {
                               $新实例 = 条带斜杠_步( $新实例 );
                               $这个->_套( $个 );

                               $old_instance（旧实例） = 发行( $所有实例[ $数字 ] ) ? $所有实例[ $个 ] : 阵列（）；

                               $was_cache_addition_suspended = wp_suspend_cache_addition（暂停缓存添加）（）；
                               如果 ( $这个->is_preview（预览）() && ! $was_cache_addition_suspended ) {
                                       wp_suspend_cache_addition（暂停缓存添加）( 真的 );
                               }

                               $实例 = $这个->更新( $新实例, $old_instance（旧实例） );

                               如果 ( $这个->is_preview（预览）() ) {
                                       wp_suspend_cache_addition（暂停缓存添加）( $was_cache_addition_suspended );
                               }

                               /**
*保存前过滤小部件的设置。
                                 *
*返回false将有效地缩短小部件的功能
*以更新设置。
                                 *
*@自2.8.0起
                                 *
*@param array$instance当前小部件实例的设置。
*@param array$new_instance新小部件设置的数组。
*@param array$old_instance旧窗口小部件设置的数组。
*@param WP_Widget$小部件当前小部件实例。
                                 */
                               $实例 = 应用筛选器( '小部件更新回调', $实例, $新实例, $old_instance（旧实例）, $这个 );

                               如果 ( 假 !== $实例 ) {
                                       $所有实例[ $个 ] = $实例；
                               }

                               打破； //只运行一次。
                       }
               }

               $这个->保存设置（_S）( $所有实例 );
               $这个->已更新 = 真的；
       }

       /**
*生成小部件控制表单（请勿覆盖）。
         *
*@自2.8.0起
         *
*@param int |数组$widget_args{
*可选。小部件实例的内部订单号或多小部件参数数组。
*默认值1。
         *
*@type int$number用于同一小部件的倍数的数字增量。
         * }
*@return string|null
         */
       公众的 功能 表单回调( $小部件_参数 = 1 ) {
               如果 ( 是数字（_N）( $小部件_参数 ) ) {
                       $小部件_参数 = 阵列( “数字” => $小部件_参数 );
               }

               $小部件_参数   = wp_parse_args( $小部件_参数, 阵列( “数字” => -1 ) );
               $所有实例 = $这个->获取设置（_S）（）；

               如果 ( -1 === $小部件_参数[“数字”] ) {
                       //我们回显出一个表单，稍后可以设置“数字”。
                       $这个->_套( '__i__' );
                       $实例 = 阵列（）；
               } 其他的 {
                       $这个->_套( $小部件_参数[“数字”] );
                       $实例 = $所有实例[ $小部件_参数[“数字”] ];
               }

               /**
*在显示控件窗体之前过滤小部件实例的设置。
                 *
*返回控制窗体的假有效短路显示。
                 *
*@自2.8.0起
                 *
*@param array$instance当前小部件实例的设置。
*@param WP_Widget$小部件当前小部件实例。
                 */
               $实例 = 应用筛选器( '小部件_窗体_回调', $实例, $这个 );

               $返回 = 无效的；

               如果 ( 假 !== $实例 ) {
                       $返回 = $这个->形式( $实例 );

                       /**
*在小部件控件窗体的末尾激发。
                         *
*使用这个钩子向小部件表单添加额外的字段。钩子
仅当传递给“widget_form_callback”的值时，才会激发*
*挂钩不是假的。
                         *
*注意：如果小部件没有表单，文本将从默认值回显
*可以使用CSS隐藏表单方法。
                         *
*@自2.8.0起
                         *
*@param WP_Widget$Widget小部件实例（通过引用传递）。
*@param null$return如果添加了新字段，则返回null。
*@param array$instance小部件设置的数组。
                         */
                       do_操作_数组( '在小部件表单中', 阵列( &$这个, &$返回, $实例 ) );
               }

               返回 $返回；
       }

       /**
*注册小部件类的实例。
         *
*@自2.8.0起
         *
*@param int$number可选。此小部件实例的唯一订单号
*与同一类的其他实例进行比较。默认值为1。
         */
       公众的 功能 _寄存器_一( $个 = -1 ) {
               wp_register_sidebar小部件(
                       $这个->身份证件,
                       $这个->名称,
                       $这个->_获取显示回调(),
                       $这个->小部件选项（_O）,
                       阵列( “数字” => $个 )
               );

               _注册表小部件更新回调(
                       $这个->id基础（_B）,
                       $这个->_获取更新回拨(),
                       $这个->控制选项（_O）,
                       阵列( “数字” => -1 )
               );

               _注册表小部件格式回调(
                       $这个->身份证件,
                       $这个->名称,
                       $这个->_获取表单回调(),
                       $这个->控制选项（_O）,
                       阵列( “数字” => $个 )
               );
       }

       /**
*保存小部件类的所有实例的设置。
         *
*@自2.8.0起
         *
*@param array$settings小部件实例设置的多维数组。
         */
       公众的 功能 保存设置（_S）( $设置 ) {
               $设置[“多窗口小部件（_M）”] = 1；
               更新选项( $这个->选项名称, $设置 );
       }

       /**
*检索小部件类的所有实例的设置。
         *
*@自2.8.0起
         *
*@return array小部件实例设置的多维数组。
         */
       公众的 功能 获取设置（_S）() {

               $设置 = 获取选项（_O）( $这个->选项名称 );

               如果 ( 假 === $设置 ) {
                       $设置 = 阵列（）；
                       如果 ( 发行( $这个->可选名称 ) ) {
                               //从替代（传统）选项获取设置。
                               $设置 = 获取选项（_O）( $这个->可选名称, 阵列() );

                               //删除替代（传统）选项，因为将使用`$this->option_name`创建新选项。
                               删除选项( $这个->可选名称 );
                       }
                       //保存一个选项，以便下次自动加载。
                       $这个->保存设置（_S）( $设置 );
               }

               如果 ( ! 是数组（_A）( $设置 ) && ! ( $设置 运算符 数组对象 || $设置 运算符 数组迭代器 ) ) {
                       $设置 = 阵列（）；
               }

               如果 ( ! 空的( $设置 ) && ! 发行( $设置[“多窗口小部件（_M）”] ) ) {
                       //旧格式，如果是单个小部件，则进行转换。
                       $设置 = wp_convert_widget_settings（wp_convert_widget_settings）( $这个->id基础（_B）, $这个->选项名称, $设置 );
               }

               未设置( $设置[“多窗口小部件（_M）”], $设置['__i__'] );

               返回 $设置；
       }
}