web-dev-qa-db-fra.com

Référence de classe d'objets WordPress

Dans WordPress, plusieurs objets sont définis via des classes suffisamment documentées.

Ce sont les WP_Query, WPDB, WP_Post et autres.

Cependant, il existe d'autres objets réellement créés au moment de l'exécution, convertissant généralement un tableau en objet standard ou lisant à partir de la base de données.

Par exemple, l'objet taxonomie que vous obtenez de la fonction get_taxonomy().

Même s’il n’existe pas de classe détaillée définissant ces objets, (== --- ==) je me demande s’il existe une documentation détaillée de toutes les propriétés que nous pouvons trouver dans ces objets qui ne me demande pas toujours de creuser dans le code pour savoir quels sont les noms de propriétés.

developmentdocumentation
5
Andrea Sciamanna

Il n’existe aucune documentation de ce type et je n’en attends pas de si tôt. WordPress pourrait implémenter des objets de propriété spécialisés pour ces cas. Pour get_taxonomies(), il pourrait ressembler à ceci:

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() {}
}

Votre IDE fournirait alors les méthodes par saisie semi-automatique. Plus besoin de chercher manuellement.

Mais il y a au moins deux raisons pour lesquelles cela ne se produira pas dans un avenir proche.

  1. L'implémentation de OOP dans le code noyau présente peu d'intérêt. Si vous trouvez un objet, il en fait trop (regardez WP_Screen pour un exemple) ou bien il s'agit d'une bibliothèque tierce (SimplePie).

  2. Cela nécessiterait un grand nettoyage, car de nombreux objets sont de facto cachés. Un exemple de la classe Walker_Nav_Menu; regardez très attentivement le $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 n'est pas un tableau, c'est l'un de ces objets bâclés, créés avec le transtypage dans la fonction wp_nav_menu(): $args = (object) $args;.

Maintenant quoi? Vous ne pouvez pas modifier les signatures dans Walker_Nav_Menu, car il s'agit d'une classe enfant de Walker (une des nombreuses raisons pour lesquelles l'héritage est un mauvais concept). Changer les signatures de la classe enfant soulèverait des notifications E_STRICT. Vous ne pouvez pas simplement passer un tableau, car cela briserait de nombreux marcheurs tiers. Lorsque vous introduisez de nouveaux objets, vous devez corriger les classes qui les utilisent en premier. Et il y a probablement beaucoup de cas comme celui-ci.

1
fuxia