web-dev-qa-db-ja.com

WordPressオブジェクトクラスリファレンス

WordPressでは、十分に文書化されたクラスを通して定義されたいくつかのオブジェクトがあります。

これらはWP_Query、WPDB、WP_Postなどです。

ただし、実行時に実際に作成されるオブジェクトは他にもあります。通常は、配列を標準オブジェクトに変換するか、DBから読み込みます。

たとえば、get_taxonomy()関数から取得した分類オブジェクトです。

これらのオブジェクトを定義する実際のクラスはありませんが、これらのオブジェクトで見つけることができるすべてのプロパティの詳細なドキュメントがあるかどうかプロパティ名がどれであるかを覚えておくためにコードを常に掘る必要はありません。

developmentdocumentation
5
Andrea Sciamanna

そのようなドキュメンテーションはありません、そして私はすぐにいつかそれを期待しません。 WordPressはこれらの場合に特化したプロパティオブジェクトを実装することができます。get_taxonomies()の場合は次のようになります。

class WP_Taxonomy_Properties {

    private $data;

    public function __construct( Array $data ) {
        $this->data = $data;
    }

    public function get_labels() {
        return $this->data['labels'];
    }
    public function get_description() {}
    public function get_public() {}
    public function get_hierarchical() {}
    public function get_show_ui() {}
    public function get_show_in_menu() {}
    public function get_show_in_nav_menus(){}
    public function get_show_tagcloud() {}
    public function get_meta_box_cb() {}
    public function get_capabilities() {}
    public function get_rewrite() {}
    public function get_query_var() {}
    public function get_update_count_callback() {}
    public function is_builtin() {}
}

あなたのIDEはオートコンプリートごとにメソッドを提供します。手動で検索する必要はもうありません。

しかし、これが近い将来に起こらない理由は少なくとも2つあります。

  1. コアコードにOOPを実装することにはほとんど関心がありません。もしあなたがオブジェクトを見つけたとしても、それは多すぎる（例としてWP_Screenを見てください）か、それはサードパーティのライブラリ（SimplePie）です。

  2. 多くのオブジェクトは事実上隠されているため、大規模なクリーンアップが必要になります。クラスWalker_Nav_Menuからの例。 $argsをよく見てください。

    /**
 * Start the element output.
 *
 * @see Walker::start_el()
 *
 * @since 3.0.0
 *
 * @param string $output Passed by reference. Used to append additional content.
 * @param object $item   Menu item data object.
 * @param int    $depth  Depth of menu item. Used for padding.
 * @param array  $args   An array of arguments. @see wp_nav_menu()
 * @param int    $id     Current item ID.
 */
function start_el( &$output, $item, $depth = 0, $args = array(), $id = 0 ) {
    $indent = ( $depth ) ? str_repeat( "\t", $depth ) : '';

    $class_names = $value = '';

    $classes = empty( $item->classes ) ? array() : (array) $item->classes;
    $classes[] = 'menu-item-' . $item->ID;

    /**
     * Filter the CSS class(es) applied to a menu item's <li>.
     *
     * @since 3.0.0
     *
     * @param array  $classes The CSS classes that are applied to the menu item's <li>.
     * @param object $item    The current menu item.
     * @param array  $args    An array of arguments. @see wp_nav_menu()
     */
    $class_names = join( ' ', apply_filters( 'nav_menu_css_class', array_filter( $classes ), $item, $args ) );
    $class_names = $class_names ? ' class="' . esc_attr( $class_names ) . '"' : '';

    /**
     * Filter the ID applied to a menu item's <li>.
     *
     * @since 3.0.1
     *
     * @param string The ID that is applied to the menu item's <li>.
     * @param object $item The current menu item.
     * @param array $args An array of arguments. @see wp_nav_menu()
     */
    $id = apply_filters( 'nav_menu_item_id', 'menu-item-'. $item->ID, $item, $args );
    $id = $id ? ' id="' . esc_attr( $id ) . '"' : '';

    $output .= $indent . '<li' . $id . $value . $class_names .'>';

    $atts = array();
    $atts['title']  = ! empty( $item->attr_title ) ? $item->attr_title : '';
    $atts['target'] = ! empty( $item->target )     ? $item->target     : '';
    $atts['rel']    = ! empty( $item->xfn )        ? $item->xfn        : '';
    $atts['href']   = ! empty( $item->url )        ? $item->url        : '';

    /**
     * Filter the HTML attributes applied to a menu item's <a>.
     *
     * @since 3.6.0
     *
     * @param array $atts {
     *     The HTML attributes applied to the menu item's <a>, empty strings are ignored.
     *
     *     @type string $title  The title attribute.
     *     @type string $target The target attribute.
     *     @type string $rel    The rel attribute.
     *     @type string $href   The href attribute.
     * }
     * @param object $item The current menu item.
     * @param array  $args An array of arguments. @see wp_nav_menu()
     */
    $atts = apply_filters( 'nav_menu_link_attributes', $atts, $item, $args );

    $attributes = '';
    foreach ( $atts as $attr => $value ) {
        if ( ! empty( $value ) ) {
            $value = ( 'href' === $attr ) ? esc_url( $value ) : esc_attr( $value );
            $attributes .= ' ' . $attr . '="' . $value . '"';
        }
    }

    $item_output = $args->before;
    $item_output .= '<a'. $attributes .'>';
    /** This filter is documented in wp-includes/post-template.php */
    $item_output .= $args->link_before . apply_filters( 'the_title', $item->title, $item->ID ) . $args->link_after;
    $item_output .= '</a>';
    $item_output .= $args->after;

    /**
     * Filter a menu item's starting output.
     *
     * The menu item's starting output only includes $args->before, the opening <a>,
     * the menu item's title, the closing </a>, and $args->after. Currently, there is
     * no filter for modifying the opening and closing <li> for a menu item.
     *
     * @since 3.0.0
     *
     * @param string $item_output The menu item's starting HTML output.
     * @param object $item        Menu item data object.
     * @param int    $depth       Depth of menu item. Used for padding.
     * @param array  $args        An array of arguments. @see wp_nav_menu()
     */
    $output .= apply_filters( 'walker_nav_menu_start_el', $item_output, $item, $depth, $args );
}

$argsは配列ではありません。関数wp_nav_menu()：$args = (object) $args;の型キャストで作成されたこれらのずさんなオブジェクトの1つです。

それで？ Walker_Nav_Menuのシグネチャは変更できません。なぜならそれはWalkerの子クラスだからです（継承が悪い概念である多くの理由の1つ）。子クラスのシグネチャを変更するとE_STRICTという通知が表示されます。配列を渡すことはできません。サードパーティのウォーカーの多くが壊れるためです。新しいオブジェクトを導入するときは、最初にそれらを使用しているクラスを修正する必要があります。そして、おそらくこのような多くのケースがあります。

1
fuxia